精华内容
下载资源
问答
  • 代码注释规范
    2020-12-29 09:35:17

    注释规范

    包注释

    每个包都应该有一个包注释,一个位于 package 子句之前的块注释或行注释。包如果有多个 go 文件,只需要出现在一个 go 文件中(一般是和包同名的文件)即可。 包注释应该包含下面基本信息(请严格按照这个顺序,简介,创建人,创建时间):

    // @Title 
    // @Description 
    // @Author 创建人 创建时间
    // @Update  创建人 修改时间

    结构(接口)注释

     

    每个自定义的结构体或者接口都应该有注释说明,该注释对结构进行简要介绍,放在结构体定义的前一行,格式为: 结构体名, 结构体说明。同时结构体内的每个成员变量都要有说明,该说明放在成员变量的后面(注意对齐),实例如下:

     

    // User , 用户对象,定义了用户的基础信息
    type User struct{
        UserName  string `description:"用户名称"`
        Email     string `description:"邮箱"`
    }
    

    函数 注释

    // @Title 标题
    // @Description 详细信息
    // @Auth 创建时间 创建人
    // @Param 参数类型 参数介绍
    // @Return 返回类型 "错误信息"

     

    更多相关内容
  • 代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。下面通过本文说一下我们在日常开发中使用的代码注释规范
  • Java代码注释规范详解

    2020-09-02 19:50:01
    代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用。下面给大家分享java代码注释规范,需要的朋友参考下
  • 代码注释规范

    2012-07-19 15:05:08
    写注释的一些规范,让注释更加清晰,里面简单讲了C,C++,C#的注释规范
  • 2. 注释里的URL 不要使用反斜杠连接行. Python会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号. Yes: foo_bar(self, width, height, ...
  • 主要介绍了Python代码注释规范代码实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
  • java代码注释规范

    2022-03-29 07:28:41
    如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范。 2. 内容准确简洁 内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而...

    遵循原则

    1. 形式统一

    在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范。

    2. 内容准确简洁

    内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。

    注释条件

    1. 基本注释(必须加)

    • 类(接口)的注释
    • 构造函数的注释
    • 方法的注释
    • 全局变量的注释
    • 字段/属性的注释

     简单的代码做简单注释,注释内容不大于10个字即可,另外,持久化对象或VO对象的getter、setter方法不需加注释。具体的注释格式请参考下面举例。

    2. 特殊必加注释(必须加)

    典型算法必须有注释。

    在代码不明晰处必须有注释。

    在代码修改处加上修改标识的注释。

    在循环和逻辑分支组成的代码中加注释。

    为他人提供的接口必须加详细注释。

     此类注释格式暂无举例。具体的注释格式自行定义,要求注释内容准确简洁。


    注释格式

    1. 单行(single-line)注释:“//……”

    2. 块(block)注释:“/*……*/”

    3. 文档注释:“/**……*/”

    4. javadoc 注释标签语法

    @author   对类的说明 标明开发该类模块的作者

    @version   对类的说明 标明该类模块的版本

    @see     对类、属性、方法的说明 参考转向,也就是相关主题

    @param    对方法的说明 对方法中某参数的说明

    @return   对方法的说明 对方法返回值的说明

    @exception  对方法的说明 对方法可能抛出的异常进行说明


    参考举例

    1. 类(接口)注释

    /**
    
    * 类的描述
    
    * @author Administrator
    
    * @Time 2012-11-2014:49:01
    
    *
    
    */
    
    public classTest extends Button {
    
      ……
    
    }

    2. 构造方法注释

    public class Test extends Button {
    
      /**
    
       * 构造方法 的描述
    
       * @param name
    
       *       按钮的上显示的文字
    
       */
    
      public Test(String name){
    
         ……
    
      }
    
    }

    3. 方法注释

    public class Test extends Button {
    
      /**
    
       * 为按钮添加颜色
    
       *@param color
    
             按钮的颜色
    
    *@return
    
    *@exception  (方法有异常的话加)
    
    * @author Administrator
    
    * @Time2012-11-20 15:02:29
    
    
       */
    
      public voidaddColor(String color){
    
         ……
    
      }
    
    }

    4. 全局变量注释
    例如:

    public final class String
    
       implements java.io.Serializable, Comparable<String>,CharSequence
    
    {
    
       /** The value is used for characterstorage. */
    
       private final char value[];
    
       /** The offset is the first index of thestorage that is used. */
    
       private final int offset;
    
       /** The count is the number of charactersin the String. */
    
       private final int count;
    
       /** Cache the hash code for the string */
    
    private int hash; // Default to 0
    
    ……
    
    }

    5. 字段/属性注释

    public class EmailBody implements Serializable{
    
       private String id;
    
       private String senderName;//发送人姓名
    
       private String title;//不能超过120个中文字符
    
       private String content;//邮件正文
    
       private String attach;//附件,如果有的话
    
       private String totalCount;//总发送人数
    
       private String successCount;//成功发送的人数
    
       private Integer isDelete;//0不删除 1删除
    
       private Date createTime;//目前不支持定时 所以创建后即刻发送
    
       privateSet<EmailList> EmailList;
    
    ……
    
    }
    展开全文
  • 本篇文章是对PHPDocument代码注释规范进行了详细的总结与介绍,需要的朋友参考下
  • git提交代码注释规范

    2018-01-12 16:24:01
    git提交代码注释规范、git提交常用操作的规范指南、[A] 新增 :(新加入的需求) [M] 修改 :( 修改或者重构代码) [D] 删除 :(删除多余的文件 ) [F] 修复 :(修复bug)
  • 代码注释规范整理

    千次阅读 2021-05-22 18:52:48
    好的注释规范可以尽可能的减少一个软件的维护成本,并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。好的注释规范可以改善软件的可读性,可以让开发人员尽快而彻底地

    转载自51CTO大佬yuke198907 原文章地址:https://blog.51cto.com/yuke198907/1300804(侵删)

    版权这个很重要

    程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本,并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。好的注释规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯,甚至锻炼出更加严谨的思维能力。
    一、注释的原则

    1、注释形式统一
    在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同,按照他们的规范写代码,不要试图在既成的规范系统中引入新的规范。
    2、注释的简洁
    内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。
    3、注释的一致性
    在写代码之前或者边写代码边写注释,因为以后很可能没有时间来这样做。另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建,解释性注释在开发过程中创建,提示性注释在代码完成之后创建。修改代码的同时修改相应的注释,以保证代码与注释的同步。
    4、注释的位置
    保证注释与其描述的代码相邻,即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置,不可放在下方。避免在代码行的末尾添加注释;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释要对齐。
    5、注释的数量
    注释必不可少,但也不应过多,在实际的代码规范中,要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”,而不是文档,程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱,注释的花样要少。不要被动的为写注释而写注释。
    6、删除无用注释
    在代码交付或部署发布之前,必须删掉临时的或无关的注释,以避免在日后的维护工作中产生混乱。
    7、复杂的注释
    如果需要用注释来解释复杂的代码,请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码,而应该重写它。尽管一般不应该为了使代码更简单便于使用而牺牲性能,但必须保持性能和可维护性之间的平衡。
    8、多余的注释
    描述程序功能和程序各组成部分相互关系的高级注释是最有用的,而逐行解释程序如何工作的低级注释则不利于读、写和修改,是不必要的,也是难以维护的。避免每行代码都使用注释。如果代码本来就是清楚、一目了然的则不加注释,避免多余的或不适当的注释出现。
    9、必加的注释
    典型算法必须有注释。在代码不明晰或不可移植处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。为了防止问题反复出现,对错误修复和解决方法的代码使用注释,尤其是在团队环境中。
    10、注释在编译代码时会被忽略,不编译到最后的可执行文件中,所以注释不
    会增加可执行文件的大小。
    二、JAVA注释技巧

    1、空行和空白字符也是一种特殊注释。利用缩进和空行,使代码与注释容易区别,并协调美观。
    2、当代码比较长,特别是有多重嵌套时,为了使层次清晰,应当在一些段落的结束处加注释(在闭合的右花括号后注释该闭合所对应的起点),注释不能写得很长,只要能表示是哪个控制语句控制范围的结束即可,这样便于阅读。
    3、将注释与注释分隔符用一个空格分开,在没有颜色提示的情况下查看注释时,这样做会使注释很明显且容易被找到。
    4、不允许给块注释的周围加上外框。这样看起来可能很漂亮,但是难于维护。
    5、每行注释(连同代码)不要超过120个字(1024×768),最好不要超过80字(800×600)。
    6、Java编辑器(IDE)注释快捷方式。Ctrl+/ 注释当前行,再按则取消注释。

    7、对于多行代码的注释,尽量不采用“/*....*/”,而采用多行“//”注释,这样虽然麻烦,但是在做屏蔽调试时不用查找配对的“/*....*/”。
    8、注释作为代码切换开关,用于临时测试屏蔽某些代码。
    例一:

    1<font face="宋体 "><font style="font-size: 11.5pt"><code id="code0"//*/
    2codeSegement1;
    3//*/</code></font></font>

     

    改动第一行就成了:

    1<font face="宋体 "><font style="font-size: 11.5pt"><code id="code1"/*/
    2codeSegement1;
    3//*/</code></font></font>

     

    例二:

    1<font face="宋体 "><font style="font-size: 11.5pt"><code id="code2"//----------------------第一段有效,第二段被注释
    2//*/
    3codeSegement1;
    4/*/
    5codeSegement2;
    6//*/</code></font></font>

     

    只需删除第一行的/就可以变成:

    1<code id="code3"//----------------------第一段被注释,第二段有效
    2/*/
    3codeSegement1;
    4/*/
    5codeSegement2;
    6//*/</code>

    三、JAVA注释方法及格式

     

    1、单行(single-line)--短注释://……
    单独行注释:在代码中单起一行注释,注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。
    注释格式:/* 注释内容 */
    行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。
    注释格式:// 注释内容
    行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。
    注释格式:代码 + 8(至少4)个空格 + // 注释内容
    2、块(block)--块注释:/*……*/
    注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成:
    /*
    * 注释内容
    */
    3、文档注释:/**……*/
    注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符/**.。..。.*/之中,注释文档将用来生成HTML格式的代码报告,所以注释文档必须书写在类、域、构造函数、方法,以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下:

    01<font face="宋体 "><font style="font-size: 11.5pt"><code id="code4"/**
    02* The doGet method of the servlet.
    03* This method is called when a form has its tag value method
    04* equals to get.
    05* @param request
    06* the request send by the client to the server
    07* @param response
    08* the response send by the server to the client
    09* <a href="http://home.51cto.com/index.php?s=/space/2305405" target="_blank">@throws</a> ServletException
    10* if an error occurred
    11* <a href="http://home.51cto.com/index.php?s=/space/2305405" target="_blank">@throws</a> IOException
    12* if an error occurred
    13*/
    14publicvoiddoGet (HttpServletRequest request, HttpServletResponse response)
    15throwsServletException, IOException {
    16doPost(request, response);
    17}</code></font></font>

     

    前两行为描述,描述完毕后,由@符号起头为块标记注释。

    更多有关文档注释和javadoc的详细资料,参见javadoc的主页:http://java.sun.com/javadoc/index.html
    4、javadoc注释标签语法
    @author对类的说明:标明开发该类模块的作者
    @version 对类的说明:标明该类模块的版本
    @see 对类、属性、方法的说明:参考转向,也就是相关主题
    @param 对方法的说明:对方法中某参数的说明
    @return对方法的说明:对方法返回值的说明
    @exception对方法的说明:对方法可能抛出的异常进行说明
    四、JAVA注释具体实现

    1、源文件注释
    源文件注释采用 /** …… */,在每个源文件的头部要有必要的注释信息,包括:文件名;文件编号;版本号;作者;创建时间;文件描述包括本文件历史修改记录等。中文注释模版:

    01<code id="code5"/**
    02* 文件名:
    03* CopyRright (c) 2008-xxxx:
    04* 文件编号:
    05* 创建人:
    06* 日期:
    07* 修改人:
    08* 日期:
    09* 描述:
    10* 版本号:
    11*/</code>

     

    2、类(模块)注释:
    类(模块)注释采用 /** …… */,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模块)历史修改记录等。
    英文注释模版:

    01<font face="宋体 "><font style="font-size: 11.5pt"><code id="code6"/**
    02* CopyRright (c)2008-xxxx:《展望软件Forsoft 》
    03* Project:《项目工程名》
    04* Module ID:《(模块)类编号,可以引用系统设计中的类编号》
    05* Comments:《对此类的描述,可以引用系统设计中的描述》
    06* JDK version used:《JDK1.6》
    07* Namespace:《命名空间》
    08* Author:《作者中文名或拼音缩写》
    09* Create Date:《创建日期,格式:YYYY-MM-DD》
    10* Modified By:《修改人中文名或拼音缩写》
    11* Modified Date:《修改日期,格式:YYYY-MM-DD》
    12* Why & What is modified 《修改原因描述》
    13* Version:《版本号》
    14*/</code></font></font>

     

    如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释:

    01<code id="code7"//Rewriter
    02//Rewrite Date:《修改日期:格式YYYY-MM-DD》 Start1:
    03/* 原代码内容*/
    04//End1:将原代码内容注释掉,然后添加新代码使用以下注释:
    05//Added by
    06//Add date:《添加日期,格式:YYYY-MM-DD》 Start2:
    07//End2:如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下注释:
    08//Log ID:《Log编号,从1开始一次增加》
    09//Depiction:《对此修改的描述》
    10//Writer:修改者中文名
    11//Rewrite Date:《模块修改日期,格式:YYYY-MM-DD》</code>

     

    2、接口注释:
    接口注释采用 /** …… */,在满足类注释的基础之上,接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用,块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。
    3、构造函数注释:
    构造函数注释采用 /** …… */,描述部分注明构造函数的作用,不一定有块标记部分。
    注释模版一:

    1<font face="宋体 "><font style="font-size: 11.5pt"><code id="code8"/**
    2* 默认构造函数
    3*/</code></font></font>

     

    注释模版二:

    1<code id="code9"/**
    2* Description :带参数构造函数,初始化模式名,名称和数据源类型
    3* @param schema:模式名
    4* @param name:名称
    5* @param type:数据源类型
    6*/</code>

     

    4、函数注释:
    函数注释采用 /** ……*/,在每个函数或者过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等。函数注释里面可以不出现版本号(@version)。
    注释模版一:

    01<font face="宋体 "><font style="font-size: 11.5pt"><code id="code10"/**
    02* 函数名:
    03* 功能描述:
    04* 输入参数:《按照参数定义顺序》
    05* 《@param后面空格后跟着参数的变量名字
    06* (不是类型),空格后跟着对该参数的描述。》
    07* 返回值: - 类型
    08* 《返回为空(void)的构造函数或者函数,
    09* @return可以省略; 如果返回值就是输入参数,必须 * 用与输入参数的@param相同的描述信息; 必要的时* 候注明特殊条件写的返回值。》
    10* 异常:《按照异常名字的字母顺序》
    11* 创建人:
    12* 日期:
    13* 修改人:
    14* 日期:
    15*/</code></font></font>

     

    注释模版二:

    1<code id="code11"/**
    2* FunName: getFirstSpell
    3* Description :获取汉字拼音首字母的字符串,被生成百家姓函数调用
    4* @param: str the String是包含汉字的字符串
    5* <a href="http://home.51cto.com/index.php?s=/space/34010" target="_blank">@return</a> String:汉字返回拼音首字母字符串;英文字母返回对应的大写字母;其他非简体汉字返回 ‘0’;
    6* @Author: ghc
    7* <a href="http://home.51cto.com/index.php?s=/space/698871" target="_blank">@Create</a> Date: 2008-07-02
    8*/</code>

     

    5、方法注释:
    方法注释采用 /** …… */,对于设置(Set 方法)与获取(Get 方法)成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索。
    6、方法内部注释:
    控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释。
    7、全局变量注释:
    要有较详细的注释,包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。
    8、局部(中间)变量注释:
    主要变量必须有注释,无特别意义的情况下可以不加注释。
    9、实参/参数注释:
    参数含义、及其它任何约束或前提条件。
    10、字段/属性注释:
    字段描述,属性说明。
    11、常量:常量通常具有一定的实际意义,要定义相应说明。

    展开全文
  • git commit -m “本次提交注释信息规范” 1.2 注释分类 feat: 修改/增加新功能 fix: 修改bug的变更 docs: 文档相关变更 style: 不影响代码含义的变更(空白、格式、缺少符号等) refactor: 代码重构变更 perf: 改进...

    1.1 简述

    git commit -m “本次提交注释信息规范”

    1.2 注释分类

    feat: 修改/增加新功能
    fix: 修改bug的变更
    docs: 文档相关变更
    style: 不影响代码含义的变更(空白、格式、缺少符号等)
    refactor: 代码重构变更
    perf: 改进性能的变更
    test: 添加/修改现有的测试
    chore: Build, .gitignore或辅助工具、库(如文档生成)等变更

    1.3 示例如下

    1.feat:增加新功能

    git commit -m 'feat: xx'
    

    2.fix:修改bug的提交

    git commit -m 'fix: xxx'
    

    3.style:样式修改、布局修改

    git commit -m 'style: xxx'
    
    展开全文
  • 阿里巴巴内部 代码格式化规范xml,code 导入XML 。 阿里巴巴内部 代码格式化规范xml,code 导入XML 阿里巴巴内部 代码格式化规范xml,code 导入XML 阿里巴巴内部 代码格式化规范xml,code 导入XML 阿里巴巴内部...
  • Java代码注释规范.docx

    2022-05-09 10:38:03
    Java代码注释规范
  • 来源:计量经济学服务中心经济金融及Python应用讲义一、注释1、为什么需要注释如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了。可以发现,在编写代码的过程中,我们需要对代码进行解释...
  • Doxygen代码注释规范

    2015-02-06 16:30:45
    自己的编写的Doxygen代码注释规范,包括安装、使用和规范,很详细。可以直接生成.chm格式的注释文档,对于大型程序开发很有帮助。
  • PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc。
  • java代码注释规范文档

    2018-09-18 10:33:34
    后端开发技术的代码注释规范 单行注释 多行注释 块注释 文档注释 标签注释等等
  • PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc
  • JS代码注释规范

    千次阅读 2020-06-02 19:00:16
    JS代码注释规范基本参数 基本参数 @param @argument 指定参数名和说明来描述一个函数参数 @returns 描述函数的返回值 @author 指示代码的作者 @deprecated 指示一个函数已经废弃,而且在将来的代码版本中将彻底删除...
  • vue项目代码注释规范

    万次阅读 多人点赞 2020-02-20 11:48:16
    文件注释规范 ​ 单个文件注释规范,每个独立的VUE文件开头都要进行注释,表明该文件的描述信息、作者、创建时间等。 <!-- * @FileDescription: 该文件的描述信息 * @Author: 作者信息 * @Date: 文件创建时间 ...
  • JS代码注释规范与示例文件注释普通注释文档注释函数注释规范 文件注释 文件注释位于文件的最前面,应包括文件的以下信息:概要说明及版本(必须)项目地址(开源组件必须)版权声明(必须)开源协议(开源组件必须)...
  • 为了别人学习,同时为了自己以后对代码进行‘升级’,看看js/javascript代码注释规范与示例。来自:http://www.56.com/style/-doc-/v1/tpl/js_dev_spec/spec-comment.html 文件注释 文件注释位于文件的最前面,应...
  • JAVA代码注释规范codetemplates.xml,可直接导入Eclipse,代码注释效果很棒!
  • word. PAGE / NUMPAGESword....DOCTYPE html> <html lang="en> <head> <meta charset="UTF-8> <title>标题</title> </head> <body> </body> </html> 注释/*header start*/ 内容区域 /*header end*/ CSS 书写规范

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 231,003
精华内容 92,401
关键字:

代码注释规范

友情链接: uml-exam.zip