Home Article Practice 注释规范

注释规范

2022-08-23 16:12  views:365  source:小键人8148422    

文件开头应该标明至少一下几项信息:Data(创建时间),Author(创建人),Description(描述)
类与类体之前应该写明类的作用域或者适用范围。函数开始前,写明方法作用,入参,返参。一段逻辑代码开始前,写明该代
码段的作用,且前后应有空行分离。较为复杂或不能一眼看出的分支或判断之后,如if/case/for等,注释判断条
件(逻辑意义),注释在行尾。变量注释,非临时变量理论上都要注释,即有具体业务意义的变量。代码与其他模块,功能,
分支有耦合的地方应注释,即注明其有不合理的关联关系(调用与被调用)。格式及命名C#命名空间:公司名 软件大类
项目名 功能名类名,方法名,公有变量,枚举值:大驼峰法其他变量(局部变量,私有变量):小驼峰法常量:全大写字母
+下划线代码格式:常见运算符两端空格,如“+-*/<>=,”等缩进使用Tab而不是空格类中的变量按其特性分为几
个部分:常量,类(静态)变量,对象变量,对象变量,后初始化变量(类或对象生成前不能初始化变量),每个部分以空行
分隔类,方法,代码逻辑分段之间应有空行,除此之外禁止滥用空行,切忌使用一行代码一行空行的书写方式。
当代码视觉结构相同时应在较大的分隔处使用整行分隔,如C#使用整行“/”并在其中间写上该代码的描述,这样做可降低
视觉疲劳。
代码逻辑压缩:考虑代码的执行路径,每行代码的必要性,是否有更简洁的逻辑写法(在不使用高级语法特性的时候)
代码压缩
为避免出现冗长繁琐的代码
缩进字符压缩:visual studio的默认缩进字符为空格,应修改为Tab,同样缩进的情况下一个tab
字符通常是4个空格,这有助于减小源代码文件体积
作用域关键字缩写:利用语言本身的默认作用域,当变量或函数的访问控制符为默认的控制符时应不写,
如类中的“private int a;‘ 应改为”int a;“
get/set书写误用:禁止书写空的get/set方法,如”int value{get;set;}“
应写为”int value;“
变量定义:当一些变量是紧密相关的且同类型时写在同一关键字定义下,如”double width;
double height;" 应写成double width , height.



Disclaimer: The above articles are added by users themselves and are only for typing and communication purposes. They do not represent the views of this website, and this website does not assume any legal responsibility. This statement is hereby made! If there is any infringement of your rights, please contact us promptly to delete it.

字符:    改为:
去打字就可以设置个性皮肤啦!(O ^ ~ ^ O)