zoukankan      html  css  js  c++  java
  • 代码规范之C#注释

    注释:(摘抄,自己学习用)    了解一本书---> .Net设计规范

    在C#中,程序注释有三种。

    关于程序注释需要理解的是:注释是给阅读程序的人看的,不是给编译器或操作系统执行指令功能的,没有这个作用。

     三种注释:

    1. //单行注释;

    2. /*

      多行或一段注释

      */

    3. ///<summary>

      ///这是对类的说明

      ///</summary>

      ///<summary>

      ///这是对方法的说明

      ///</summary>

      ///<param  name=“args”></param>

    指示代码折叠指令

      #region  这是第一段代码

      code

      ........

      #endregion

     

    注释语法

           为了使用C#提供的XML注释功能,你的注释应该使用特殊的注释语法(///)开头。在///之后,你可以使用预先定义的标签注释你的代码,也可以插入你自己定义的标签。你定制的标签将会在随后加入到生成的注释文档中。

    预定义的标签              用处

    <c>                             将说明中的文本标记为代码

    <code>                       提供了一种将多行指示为代码的方法

    <example>                  指定使用方法或其他库成员的示例

    <exception>            允许你指定可能发生的异常类

    <include>                    允许你引用描述源代码中类型和成员的另一文件中的注释使用 XML                       XPath 语法来描述你的源代码中的类型和成员。

    <list>                           XML注释文档中插入一个列表

    <para>                        XML注释文档中插入一个段落

    <param>                     描述一个参数

    <paramref>                 提供了一种指示一个词为参数的方法

    <permission>              允许你将成员的访问许可加入到文档中

    <remarks>                  用于添加有关某个类型的信息

    <returns>                    描述返回值

    <see>                         指定链接

    <seealso>                   指定希望在请参见一节中出现的文本

    <summary>                 类型或类型成员的通用描述

    <value>                       描述属性

  • 相关阅读:
    reStructuredText学习
    PYTHON编码处理-str与Unicode的区别
    如何参与一个GitHub开源项目?
    Boost库编译安装
    git push失败the remote end hung up unexpectedly
    VBox虚拟机安装debian
    debian设置英文模式
    python 使用json.dumps() 的indent 参数添加缩进空格数,格式化字符串后输出
    unittest之装饰器 @classmethod
    jmeter正则提取信息头数据
  • 原文地址:https://www.cnblogs.com/maomiyouai/p/2663661.html
Copyright © 2011-2022 走看看