c#编码规范
2020-07-28 16:44:02 0 举报AI智能生成
c#编码规范
作者其他创作
大纲/内容
4.注释
注释约定
类注释约定
类属性注释约定
方法注释约定
代码间注释约定
何时写注释的约定
常用注释标识的约定
关于何时使用“///”和“//”的约定
不需要的注释
不要为了注释而注释
不要用注释来粉饰糟糕的代码
日志式注释
个人签名
位置标识
注释掉的代码
需要的注释
记录你对代码有价值的见解
为代码中的不足写注释
对意料之中的疑问添加注释
公布可能的陷阱
对于代码块总结性地注释
5.如何写好注释
避免使用不明确的代词
精确描述方法的行为
用输入输出例子来说明特殊的情况
适当的使用具名函数
使用通用专有名词
更新代码时记得更新注释
只有能让别人读懂的注释才是合格的注释
6.格式
长度
空格、空行
换行
Region的使用
使用VS的Format Document功能
1.命名约定
PascalCasing
camelCasing
SCREAMING_CAPS
私有变量的命名
首字母缩写词的大小写
1.把两个字母的首字母缩写词全部大写，除非它是camelCasing的第一个单词。
2.由三个或以上的字母组成的首字母缩写词，只有第一个字母大写，如Xml,Html.除非首字母是camelCasing标识符的第一个单词。
复合词的大小写
在带单位的值的变量后加上"_camelCasing单位"
不要使用匈牙利命名法
使用英语语序命名标识符
2.标识符命名的选择
名字一定要能够表达出标识符的含意
选择意义单一明确的名字
使用不会产生歧义的名字
命名要与使用者的期望相匹配
为名字附加更多的信息
不要卖弄风骚
3.特定场景下的命名最佳实践
命名空间
要让接口的名字以字母I开头
派生类的末尾使用基类名称
泛型类型参数的命名
枚举类型的命名
属性的命名
事件的命名
字段的命名
0 条评论
下一页
