【分享】代码命名与代码备注规范

时间：2024-02-18 09:50:21

代码命名与备注规范

  1. 命名规则

驼峰式命名法（Camel）：用于给普通变量（局部变量）的命名，第一个单词的首字母小写，其余的单词首字母大写。如myAge、myName。

帕斯卡命名法（Pascal）：用于给类、方法（函数）和属性（属性的本质是get和set两个函数）命名的规范，每个单词的首字母大写。如HighSchoolStudent。

　　

　　2.函数或方法

　　命名规范：Pascal（每个单词的首字母大写）

　　备注规范：

  1. [Summary] 需描述清楚该函数或方法的执行什么
  2. [param] 每个参数都必须描述清楚参数意义，在多值的情况下要一一备注清楚
  3. [renturn] 描述返回结果，如遇不同的返回值代表特定意义需描述清楚，例如若返回 1代表***

　　以下给出的C#的备注案例，其他语言大同小异　　　　

 

　　以下是js代码范例

　　

　　

　　3.属性

 　　　　命名规范：公共属性采用Pascal命名方式

　　　　私有属性采用Camel命名方式，并以下划线“_”开头，如 “_userName”

　　　　备注规范：

　　　　[summary] 描述清楚该属性的意义，如遇不同的值代表特定意义需描述清楚，例如 1代表*** 2代表***

　　　　范例：

1 ///<summary>
2 /// 用户类型 1=设计师 2=企业6=设计公司 7=设计工作室
3 ///</summary>
4 
5 public short UserType { get; set; }

 

 　　4. 变量 

　　　　命名规范：采用Camel命名方式

　　　　备注规范：只要定义变量就必须备注，在变量定义后面描述清楚该变量的意义，如遇不同的值代表特   定意义需描述清楚，例如1代表*** 2代表***

　　　　范例：

 　　　　 float step = 1;//认证步骤 营业执照认证=1 法人认证=2 管理授权=3 

 

　　5.代码段

　　if else / switch case / for等代码段 要描述清楚接下来的代码段的执行意义

　　C#应更可能的使用region对代码段进行区块化

　　以下范例视为合格 

 　　

 

　　

 

 

 　　

　　6.其他命名规范

　　　　(1)接口类以Interface的缩写 I 开头

　　　　(2)事件不要以event结尾，class不要以class结尾

　　　　(3)禁止使用缩写,除URL、IO等能达成共识的缩写除外，使用缩写可全大写

　　　　(4)在对任何东西命名时需要使用有意义的名称，并且保证单词拼写正确以及语法正确，避免使用拼音(地名等    通用拼音除外),避免使用关键字

 

相关文章