注释 注释毫无疑问是让别人以最快速度了解你代码的最快途径,但写注释的目的绝不仅仅是"解释代码做了什么",更重要的尽量帮助代码阅读者对代码了解的和作者一样多。 当你写代码时,你脑海里会有很多有价值的信息,但当其他人读你代码时,这些信息已经丢失,他们所见到的只是眼前 ...
本文是读完前言中提到的几本书后,结合自身的想法总结出来的如何写好注释的一些比较实用的方法。 另外本文是上一篇 注释篇 的一个补充 如何写好注释 避免使用不明确的代词 有些情况下, it , this 等代词指代很容易产生歧义,最安全的方式是不要使用将所有可能产生歧义的代词替换成实际指代的词。 如: Insert the data into the cache,but check if it s t ...
2014-08-01 16:37 4 2030 推荐指数:
注释 注释毫无疑问是让别人以最快速度了解你代码的最快途径,但写注释的目的绝不仅仅是"解释代码做了什么",更重要的尽量帮助代码阅读者对代码了解的和作者一样多。 当你写代码时,你脑海里会有很多有价值的信息,但当其他人读你代码时,这些信息已经丢失,他们所见到的只是眼前 ...
命名约定 我们在命名标识符时(包括参数,常量,变量),应使用单词的首字母大小写来区分一个标识符中的多个单词,如UserName. PascalCasing Pascal ...
上一篇文章讲了标识符命名的约定,今天讲下标识符命名的选择。 简单的讲,看到一个标识符一定要可以见名知意。 名字一定要能够表达出标识符的含意 标识符名字必须要表达出该标识符的意义,绝对不可以使用无意义的v1,v2…vn之类的命名。 public static void ...
格式 格式的统一使用可以使代码清晰、美观、方便阅读。为了不影响编码效率,在此只作如下规定: 长度 一个文件最好不要超过500行(除IDE自动生成的类)。 一个文件必须只有一个命名空间,严禁 ...
本文是参考阿里的Java编码规范修改的C#版本,自整理并编写,欢迎指正! 编程规约 (一)命名规约 1.【强制】代码中当且仅当私有成员可以使用下划线开始 反例:public string _name 2.【强制】代码中的命名严禁使用拼音 ...
记录 编码约定 学习过程。 命名空间约定 如果没有使用using指令,项目也没有默认导入合适的命名空间,访问这些命名空间或者类型时,则需要“完全限定名称”。 如果使用了Using指令,则不需要“完全限定名称”。 代码布局约定 不轻易更改 ...
Pascal命名法:每个单词首字母均大写。 Camel命名法:第一个单词首字母小写,其余单词首字母大写。 类: 1、使用 Pascal 大小写。 2、用名词或名词短语命名类,保证类名清晰,尽量达到望文生义的境界。 3、类名称尽量少用或不用缩写,若使用了缩写一定要在注释中详细注明类的用途 ...
今天终于把这一系列的编码规范写完了,这个编码规范算上前面阅读相关书籍,前前后后总共花了一个月的时间,也算是个人的呕心沥血之作了。 本来也没打算把这个系列写的这么长,但是在写的过程中自己搜了相关的网上资料,后来发现网上的c#代码规范很少,而且仅有的几份都很泛泛,没有实际的内容。所以自己就阅读了相关 ...