原创文章,欢迎阅读,禁止转载。本文记一下javadoc风格注释的写法,这些特殊格式的注释称作标签。按照这种规范写的注释才能生成到文档中。 块注释的写法 单行注释的写法 (标签用'@'和'\'开头都是可以的)C++常用的标签有:@file 要文档化的文件,这个必须写,否则文件中的全部忽略@author ...
分类:
编程语言 时间:
2016-10-14 17:39:26
阅读次数:
316
所花时间 (包括上课) 8:00-8:50 9:00-9:50 17:25-17:50 功能性需求和非功能性需求 、限制条件的具体内容,需求 规格说明书的模板 如何才能成功地收集 、验证需求并将需求 文档化 33 ...
分类:
其他好文 时间:
2016-10-01 00:21:11
阅读次数:
101
1 前言 2 代码风格 2.1 文件 2.2 结构 2.2.1 缩进 2.2.2 空格 2.2.3 换行 2.2.4 语句 2.3 命名 2.4 注释 2.4.1 单行注释 2.4.2 多行注释 2.4.3 文档化注释 2.4.4 类型定义 2.4.5 文件注释 2.4.6 命名空间注释 2.4.7 ...
分类:
编程语言 时间:
2016-09-25 06:11:13
阅读次数:
251
1.读了邹欣老师的构建之法,我有以下几个问题:(1)小型项目是否需要考虑复杂的软件工程知识?对于一个小型的项目来说,可能几个人在几天内就开发完毕,但是加入详细、文档化的需求分析及单元测试等内容后很可能将开发周期拖到数周,这种情况下是否还需要按照软件工程的方法去实行?(2)如何平衡开发效率和运行效率? ...
分类:
其他好文 时间:
2016-09-17 00:34:04
阅读次数:
142
在一个应用的整个开发过程中涉及到了无数的步骤。其中一些是应用的说明,图片的创作,应用的实现,和实现过后的测试阶段。写代码可能组成了这个过程的绝大部分,因为正是它给了应用生命,但是这样还不够,与它同等重要的还有代码的注释和文档编写。不管代码写的有多好,如果缺少了对应的好的注释文档,很有可能在将来带来麻 ...
分类:
编程语言 时间:
2016-09-14 12:29:50
阅读次数:
281
1.创建函数def函数名(参数):函数体return值2.文档化函数defsquare(x):‘calculatethesquareofthenumber‘returnx*x给函数写文档让别人容易理解,可以加入注释(以#开头),或者直接写上文档字符串文档字符串可以按照如下方式访问:square.__doc__‘calculatethesquareofthenumb..
分类:
编程语言 时间:
2016-08-29 20:55:02
阅读次数:
189
一、java注解java注解相关的类放在java.lang.annotation包下,其主要内容包含4个元注解和其中两个元注解的枚举类值,相对比较简单,从jdk问答即可了解4个元注解:Documented:指示某一类型的注释将通过javadoc和类似的默认工具进行文档化。应使用此类型来注释这些类型的声明:其..
分类:
其他好文 时间:
2016-08-06 22:06:25
阅读次数:
175
1.谨慎地选择方法的名称。遵循标准的命名习惯。 2.不过于追求提供便利的方法。方法太多会使类难以学习、使用、文档化、测试和维护。 3.避免过长的参数列表。目标是四个参数以下。 缩短参数列表的方法: (1)把方法分解成多个方法,可能会导致方法过多, 通过提升方法正交性,可以减少方法数目。java.ut ...
分类:
其他好文 时间:
2016-08-06 17:15:35
阅读次数:
345
一、为什么要学习UML UML是Unified Modeling Language(统一建模语言)的简称。UML是对软件密集型系统中的制品进行可视化、详述、构造和文档化的语言。制品{Artifact}是指软件开发过程中产生的各种各样的产物,如模型、源代码、测试用例等。 Ø UML建模可以达到以下目的 ...
分类:
其他好文 时间:
2016-06-15 14:27:53
阅读次数:
235
ORM Object Relational Mapping 对象关系映射(Object-Relational Mapping)提供了概念性的、易于理解的模型化数据的方法。 ORM方法论基于三个核心原则: 简单:以最基本的形式建模数据。 传达性:数据库结构被任何人都能理解的语言文档化。 精确性:基于数 ...
分类:
其他好文 时间:
2016-06-06 12:07:03
阅读次数:
156