自己总结的C#编码规范--5.如何写好注释篇
本文是读完前言中提到的几本书后，结合自身的想法总结出来的如何写好注释的一些比较实用的方法。 另外本文是上一篇 注释篇 的一个补充 如何写好注释 避免使用不明确的代词 有些情况下，"it", "this"等代词指代很容易产生歧义，最安全的方式是不要使用将所有可能产生歧义 ...
原文：自己总结的C#编码规范--4.注释篇
注释 注释毫无疑问是让别人以最快速度了解你代码的最快途径，但写注释的目的绝不仅仅是 解释代码做了什么 ，更重要的尽量帮助代码阅读者对代码了解的和作者一样多。 当你写代码时，你脑海里会有很多有价值的信息，但当其他人读你代码时，这些信息已经丢失，他们所见到的只是眼前代码。 注释约定 如果IDE提供注释格式，则尽量使用IDE提供的格式，否则使用 来注释。类 属性和方法的注释在Visual Studio ...
2014-07-29 16:31 23 7219 推荐指数：
相关推荐
c#小灶——4.注释和代码规范
为什么要写注释？ 早上我写完了代码，我和我的朋友们都能看懂，到了晚上，我还能看懂，一周后，就只有上帝能看懂了…… 将来我们写的代码量是很大的，代码又不像我们自然语言这么好理解，可能过段时间我们就不认识自己的代码了，所以我们要养成写注释的好习惯。 团队合作当中，写了注释更容易 ...
自己总结的C#编码规范--2.命名选择篇
上一篇文章讲了标识符命名的约定，今天讲下标识符命名的选择。 简单的讲，看到一个标识符一定要可以见名知意。 名字一定要能够表达出标识符的含意 标识符名字必须要表达出该标识符的意义，绝对不可以使用无意义的v1,v2…vn之类的命名。 public static void ...
自己总结的C#编码规范--6.格式篇
格式 格式的统一使用可以使代码清晰、美观、方便阅读。为了不影响编码效率，在此只作如下规定： 长度 一个文件最好不要超过500行(除IDE自动生成的类)。 一个文件必须只有一个命名空间，严禁 ...
自己总结的C#编码规范--1.命名约定篇
命名约定 我们在命名标识符时（包括参数，常量，变量），应使用单词的首字母大小写来区分一个标识符中的多个单词，如UserName. PascalCasing Pascal ...
c#编码注释
1 目录 2 前言... 3 2.1 编写目的... 3 2.2 适用范围... 4 3 命名规范... 4 3.1 ...
C#编码规范
Pascal命名法，无特殊情况，扩展名小写。 文件开始包含类似以下注释说明 文件功 ...
C#编码规范
1 规范目的 ……………………………………………………… 3 2 适用范围 ……………………………………………………… 3 3 代码注释 ……………………………………………………… 3 3.1 代码注释约定 ...