C#代码注释

2019-11-06 06:59:26

字体：大中小

来源：转载

供稿：网友

C#代码注释包括三类：1)单行注释。格式：// Comments2)多行注释。格式：/* Comments... */3) xml注释。格式: ///……（VS.Net会自动增加XML格式的注释）XML注释分为一级注释（PRimary Tags）和二级注释（Secondary Tags），前者可以单独存在，后者必须包含在一级注释内部。I 一级注释1. <remarks>对类型进行描述，功能类似<summary>，据说建议使用<remarks>;2. <summary>对共有类型的类、方法、属性或字段进行注释；3. <value>主要用于属性的注释，表示属性的制的含义，可以配合<summary>使用；4. <param>用于对方法的参数进行说明，格式：<param name="param_name">value</param>；5. <returns>用于定义方法的返回值，对于一个方法，输入///后，会自动添加<summary>、<param>列表和<returns>；6. <exception>定义可能抛出的异常，格式：<exception cref="IDNotFoundException">；7. <example>用于给出如何使用某个方法、属性或者字段的使用方法；8. <permission>涉及方法的访问许可；9. <seealso>用于参考某个其它的东东:)，也可以通过cref设置属性；10. <include>用于指示外部的XML注释；II 二级注释1. <c> or <code>主要用于加入代码段；2. <para>的作用类似HTML中的<p>标记符，就是分段；3. <pararef>用于引用某个参数；4. <see>的作用类似<seealso>，可以指示其它的方法；5. <list>用于生成一个列表；

比较以下两段代码的注释：

//权威公司编号名称(顺序)//"澳门","金宝博","立博","威廉希尔","伟德","10BET","bet 365","SNAI"static List<Int32> AuthCompanyIdList = new List<int>(){ 247, 250, 251, 252, 253, 1, 469, 179};internal static List<Int32> AuthCompanyIdList = new List<int>(){ 247/*澳门*/, 250/*金宝博*/, 251/*立博*/, 252/*威廉希尔*/, 253/*伟德*/, 1/*10BET*/, 469/*bet 365*/, 179 /*SNAI*/ 　　　　　　　　};

显然，第二种注释效果更好，利于代码维护。

这里写图片描述