关于程序中注释书写格式

《关于程序中注释书写格式》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、关于程序中注释书写格式为了大家今后工作方便，暂约定程序的注释照以下格式书写：1、程序文件注释：放在程序名称空间引用（usingSystem.IO;）的上面，主要写公司的版权、文件创建的时间、文件的主要内容、文件的名字、文件的创建标识（创建人姓名）、文件修改的时间、文件修改时的修改标识（修改人姓名）、文件修改的修改原因等（详情见文档后备注示例）；2、类的作用注释：放在类（类、接口、枚举、结构体）的声明上方，主要描述类的作用。如果类的结构比较复杂，也应该添加类的使用示例和类的流程（其它特点）（详情见文档后备注示例）；3、类的私有全局重要变量注释：放在类的全局变量声明上方

2、，主要需要注释通过命名不能正确理解的全局私有或公有（包含受保护等）变量。如果是object（特殊数组等）型变量，内部使用时结构比较复杂或有规定，需要简要的说明一下内部结构。4、类的属性的注释：放在类的属性声明上方，简要说明属性的类型和主要作用。5、类的公有方法的注释：主要说明方法的作用，方法各参数的意义和要求，方法的返回值及各种可能的返回值的特殊意义，方法可能会产生的异常，如果需要，则可以写出方法的使用示例；6、类的私有方法或重要算法的注释：除了需要说明公有方法所要求的之外，如果算法、数学运算比较复杂，需要写出算法或数学方法的理论过程或推导过程；如果算法比较长，要尽

3、可能的细分成逻辑块，并填写适当的注释；对于方法中的重要变量也要添加适当的注释，特别是对方法的结果或方法某一段的结果的方法内部不易理解的变量要添加合适的注释；对于特别复杂（重要）的方法，要添加适当的流程图或文档，给以充分的文字、图解等说明；7、文件、类或类的方法修改后的注释的变更：对于对文件或类（包括接口、枚举、结构体）或类的方法修改后，要添加修改后的相注释，要写清修改的时间、修改标识（修改人姓名）、修改的原因等一切必要的信息和一切必要变更的信息（类、方法的流程）；注释示例类：/*--------------------------------------------

4、----------------------------------------//Copyright(C)2010北京中奥维科技发展有限公司//版权所有。////文件名：AnnotationDemo1.cs//创建日期：2010-8-21//文件功能描述：注释示例1,在这个文件中有关于类（类、枚举、接口、结构体）和类的属性、//类的方法、类内部的全局变量、方法内部的重要变量的注释格式；//////创建标识：Zhaozhijian////修改标识：//修改描述：////修改标识：//修改描述：//-----------------------------------

5、----------------------------------------------------*/usingSystem;usingSystem.Collections.Generic;usingSystem.Linq;usingSystem.Text;namespaceAnnotationDemo{///

6、publicstringDemoName{get{returnm_DemoName;}set{m_DemoName=value;}}privatestringm_DemoContent;///

7、te{get{returnm_CreateDate;}}privateDateTimem_LastChangedDate;///