• C#类注释规范


    (以下内容是综合网络整理得来,并不是标准,仅供参考,如哪位有标准写法,希望能分享一下,谢谢)

    文件头部注释

    在代码文件的头部进行注释,这样做的好处在于,我们能对代码文件做变更跟踪。在代码头部分标注出创始人、创始时间、修改人、修改时间、代码的功能,这在团队开发中必不可少,它们可以使后来维护/修改的同伴在遇到问题时,在第一时间知道他应该向谁去寻求帮助,并且知道这个文件经历了多少次迭代、经历了多少个程序员的开发和修改。

    样本:

    /********************************************************************************

    ** 类名称: NewMsgBox

    ** 描述:自定义消息框类

    ** 作者: dmhai

    ** 创建时间:2013-2-12

    ** 最后修改人:(无)

    ** 最后修改时间:(无)

    ** 版权所有 (C) :dmhai

    *********************************************************************************/

    模块开始必须以以下形式书写模块注释:

       ///

             ///模块编号:<模块编号,可以引用系统设计中的模块编号>

             ///作用:<对此类的描述,可以引用系统设计中的描述>

             ///作者:作者中文名

             ///编写日期:<模块创建日期,格式:YYYY-MM-DD>

             ///

    如果模块有修改,则每次修改必须添加以下注释:

             ///

             ///Log编号:<LOG< SPAN>编号,从1开始一次增加>

             ///修改描述:<对此修改的描述>

             ///作者:修改者中文名

             ///修改日期:<模块修改日期,格式:YYYY-MM-DD>

             ///

     

    3.2.2. 类属性注释规范

    在类的属性必须以以下格式编写属性注释:

             ///

             ///属性说明

       ///

    3.2.3. 方法注释规范

    在类的方法声明前必须以以下格式编写注释

             ///

             /// 说明:<对该方法的说明>

             ///

              ///<参数说明>

             ///

             ///<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>

             ///

     

    3.2.4. 代码间注释规范

    代码间注释分为单行注释和多行注释:

             单行注释:

      //<单行注释>

             多行注释:

             /*多行注释1

              多行注释2

              多行注释3*/

    代码中遇到语句块时必须添加注释(if,for,foreach,……),添加的注释必须能够说明此语句块的作用和实现手段(所用算法等等)。

  • 相关阅读:
    oracle数据库I/O测试脚本
    Dataguard常用命令汇总
    How to Enable Real-Time Query in the Standby Database
    Oracle中Hint被忽略的几种常见情形
    ORACLE数据库一主多备DG环境(一对多)主备切换
    反向代理软件之HAproxy之调度算法
    反向代理软件之HAproxy基础
    NoSQL数据库之Redis安装
    HADOOP YARN(2):YARN资源调度器(2)入门
    git查看自己是从那个分支建的分支
  • 原文地址:https://www.cnblogs.com/dmhai/p/2910201.html
Copyright © 2020-2023  润新知