注释 注释毫无疑问是让别人以最快速度了解你代码的最快途径，但写注释的目的绝不仅仅是"解释代码做了什么"，更重要的尽量帮助代码阅读者对代码了解的和作者一样多。 当你写代码时，你脑海里会有很多有价值的信息，但当其他人读你代码时，这些信息已经丢失，他们所见到的只是眼前代码 ...

C# 提供一种机制 ， 使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中，具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成 XML 。使用这类语法的注释称为文档注释 (documentation comment ...

C# 提供一种机制，使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中，具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成 XML。使用这类语法的注释称为文档注释(documentation comment)。这些注释后面必须紧跟用户定义 ...

（以下内容是综合网络整理得来，并不是标准，仅供参考，如哪位有标准写法，希望能分享一下，谢谢） 文件头部注释 在代码文件的头部进行注释，这样做的好处在于，我们能对代码文件做变更跟踪。在代码头部分标注出创始人、创始时间、修改人、修改时间、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改 ...

c#项目代码规范 因为对于项目代码规范的目的不是很明确，所以我百度了相关知识点。 代码规范目的 1.使代码更美观、阅读更方便。 2.方便代码的交流和维护。 3.使代码逻辑更清晰、更易于理解。 代码规范可以分为两个部分： 1.代码风格规范。主要是文字上的规定。 2.代码设计规范。牵涉到 ...

1. C# 代码风格要求 1.1注释 类型、属性、事件、方法、方法参数，根据需要添加注释。 如果类型、属性、事件、方法、方法参数的名称已经是自解释了，不需要加注释；否则需要添加注释。 当添加注释时，添加方式如下图所示： 1.2 类型（类、结构、委托、接口）、字段、属性、方法、事件 ...

前言 　　小菜就是小菜，几个人搞出来的项目，让公司大牛稍微看了下，最后送出了惨不忍睹四个字。命名各种各样，五花八门，大写英文、小写英文、大写拼音、小写拼音、英文和拼音组合、字母和特殊字符（下划线等）组合。这样的项目代码要是让人来维护或者添加功能、查找bug会头痛欲裂。也没办法谁叫咱们是小菜 ...