如何做好代码注释和生成设计文档及SDK文档

中国优秀的行业应用软件产品和服务提供商福建榕基软件股份有限公司FujianRongjiSoftwareCO.,LTD.代码注释是一切的基础——如何做好代码注释和生成设计文档及SDK文档燕双龙注释的作用注释就是类的需求注释就是方法的需求注释就是属性的需求没有需求，设计将是混乱的，代码将是迷茫的。为什么非要写好注释？注释代表实际开发人员对需求的理解如果开发人员能够将需求以及自己设计的思路通过注释表达出来。那么不但可以供别人阅读，也给当前的设计留下了痕迹，以免将来忘记。注释可以指引代码的编写如果在进行编码之前，先根据需求给设计的类、方法、属性进行很好的注释。那么在时机编码过程中，这些注释将是你代码的指引，他不会让你“跑题”也不会让你出错。完善的注释是传承的基础随着软件的逐步复杂，没有哪个软件是只需要一个人来完成的。在多人协作的时候，如果没有一个很好的文档或者注释，会让代码晦涩难懂，也会耽误很多不必要的时间。注释是最直观的需求如果能将注释写的非常完善，那么其他人可以不需要翻阅大量的文档，直接在代码上就可以获得到你当初设计时所使用的资料信息。大部分的注释不合理的地方2、类注释太简单1、没有类注释3、属性注释没有标明读写情况这段代码太难看懂了大部分的注释不合理的地方这段代码太难看懂了4、可以设置的属性没有注明设置之后会有什么效果。5、解释不清晰大部分的注释不合理的地方6、构造函数或方法作用描述不清楚大部分的注释不合理的地方7、可能会抛出异常的方法并没有在注释中说明什么情况下抛出什么异常。8、返回值描述太少注释的基本要求1、尽量不要用简单的词或者短语作注释，用一句完整的话来描述是最好的。2、如果描述中出现了一些特殊名词，最好能够说明一下。3、对于类或者公共方法，最好能有一个调用的实例说明。4、如果属性的Set或者方法中可能会抛出异常，要说明可能是哪些异常。5、返回值要注明边界以及是否会返回空值。6、属性要有访问权限说明太好了终于看明白了！如何生成SDK文档？如何生成SDK文档？1、在重新生成项目时，错误列表中就会显示哪些还没写注释的。这里一般只对Public的类、属性、方法进行检测和提示。2、重新生成之后，在生成目录下会有个XML文档。如何生成SDK文档？1、运行Ndoc下的NDocGui.exe文件。对于Ndoc的使用说明请参考Ndoc的帮助文档，以及我修改代码的说明。如何生成SDK文档？1、生成的文件会存放在解决方案文件夹下。2、运行doc目录下的Documention.chm如何生成SDK文档？生成SDK文档时一些可以更改的属性如何生成SDK文档？看一下.NET类库中Form类生成结果，我们所说的几点他全都包含。如何编写设计文档如何编写设计文档将生成的类图抓图到设计文档相应的位置。然后为每个类编写说明，以及描述他们的关系。如果代码注释达到了上面要求的标准，那么类的说明可以直接拷贝类的说明文档。如何编写设计文档对于一些重要的操作，需要进行详细操作流程说明，可通过Visio的UML图形画出。然后在顺序图下面简单描述该操作的作用以及基本流程说明。如何编写设计文档对于一些重要的操作，需要进行详细操作流程说明，可通过Visio的UML图形画出。然后在顺序图下面简单描述该操作的作用以及基本流程说明。电子监管通讯简介问答、讨论中国优秀的行业应用软件产品和服务提供商对社会对他人负责，归根到底是对自己负责；让所有的合作者成为赢家，就使得榕基必然成为赢家。