精华内容
下载资源
问答
  • 代码注释规范

    2012-11-29 23:25:37
    代码注释规范
  • java代码注释规范文档

    2018-09-18 10:33:34
    后端开发技术的代码注释规范 单行注释 多行注释 块注释 文档注释 标签注释等等
  • 主要介绍了Python代码注释规范代码实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
  • 下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下。原则:1、注释形式统一在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,...

    代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下。

    原则:

    1、注释形式统一

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

    2、注释内容准确简洁

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

    注释条件:

    1、基本注释(必须加)

    (a) 类(接口)的注释

    (b) 构造函数的注释

    (c) 方法的注释

    (d) 全局变量的注释

    (e) 字段/属性的注释

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

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

    (a) 典型算法必须有注释。

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

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

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

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

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

    注释格式:

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

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

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

    4、javadoc 注释标签语法

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

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

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

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

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

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

    参考举例:

    类(接口)注释

    例如:

    /**

    * 类的描述

    * @author Administrator

    * @Time 2012-11-2014:49:01

    *

    */

    public classTest extends Button {

    ……

    }

    构造方法注释

    例如:

    public class Test extends Button {

    /**

    * 构造方法 的描述

    * @param name

    * 按钮的上显示的文字

    */

    public Test(String name){

    ……

    }

    }

    方法注释

    例如

    public class Test extends Button {

    /**

    * 为按钮添加颜色

    *@param color

    按钮的颜色

    *@return

    *@exception (方法有异常的话加)

    * @author Administrator

    * @Time2012-11-20 15:02:29

    */

    public voidaddColor(String color){

    ……

    }

    }

    全局变量注释

    例如:

    public final class String

    implements java.io.Serializable, Comparable,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

    ……

    }

    字段/属性注释

    例如:

    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;

    ……

    }

    展开全文
  • 代码注释规范

    2010-03-13 18:32:00
    源文件注释规范/*********************************************************** 文件名:** Copyright (c) 2005 - 2006 ******* 软件项目开发部门** 文件编号:** 创 建 人:** 日 期:** 修 改 人:** 日 期:** 描 述...

    源文件注释规范

    /*********************************************************
    ** 文件名:
    ** Copyright (c) 2005 - 2006 ******* 软件项目开发部门
    ** 文件编号:
    ** 创 建 人:
    ** 日     期:
    ** 修 改 人:
    ** 日     期:
    ** 描     述:
    **********************************************************/


    类注释规范

    /*********************************************************
    ** 类 编 号:<类编号,可以引用系统设计中的类编号>
    ** 作     用:<对此类的描述,可以引用系统设计中的描述>
    ** 作     者:作者中文名
    ** 编写日期:<类创建日期, 格式:YYYY-MM-DD>
    **********************************************************/


    类属性注释规范

    //
    //属性说明
    //


    方法注释规范

    /*********************************************************
    ** 函 数 名:
    ** 功能描述:
    ** 输入参数: a - 类型 <说明>
                            b - 类型 <说明>
    ** 输出参数: x - 类型 <说明>
    ** 返 回 值: - 类型 <说明>
    ** 作     者:<创建人>
    ** 日     期:
    ** 修     改:<修改人>
    ** 日     期:
    **********************************************************/


    代码间注释规范

    //
    //<注释>
    //

    展开全文
  • 下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下。原则:1、注释形式统一在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,...

    代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下。

    原则:

    1、注释形式统一

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

    2、注释内容准确简洁

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

    注释条件:

    1、基本注释(必须加)

    (a)类(接口)的注释

    (b)构造函数的注释

    (c)方法的注释

    (d)全局变量的注释

    (e)字段/属性的注释

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

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

    (a)典型算法必须有注释。

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

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

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

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

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

    注释格式:

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

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

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

    4、javadoc注释标签语法

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

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

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

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

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

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

    参考举例:

    1.类(接口)注释

    例如:

    /**

    *类的描述

    *@authorAdministrator

    * @Time 2012-11-2014:49:01

    *

    */

    publicclassTestextendsButton

    {

    ……

    }

    2.构造方法注释

    例如:

    publicclassTestextendsButton

    {

    /**

    *构造方法的描述

    *@paramname

    *按钮的上显示的文字

    */

    publicTest(String name){

    ……

    }

    }

    3.方法注释

    例如

    publicclassTestextendsButton

    {

    /**

    *为按钮添加颜色

    *@paramcolor

    按钮的颜色

    *@return

    *@exception  (方法有异常的话加)

    * @authorAdministrator

    * @Time2012-11-20 15:02:29

    */

    publicvoidaddColor(String

    color){

    ……

    }

    }

    4.全局变量注释

    例如:

    publicfinalclassString

    implementsjava.io.Serializable,

    Comparable,CharSequence

    {

    /** The value is used for characterstorage. */

    privatefinalcharvalue[];

    /** The offset is the first index of thestorage that is used. */

    privatefinalintoffset;

    /** The count is the number of charactersin the String. */

    privatefinalintcount;

    /** Cache the hash code for the string */

    privateinthash;//

    Default to 0

    ……

    }

    5.字段/属性注释

    例如:

    publicclassEmailBodyimplementsSerializable{

    privateStringid;

    privateStringsenderName;//发送人姓名

    privateStringtitle;//不能超过120个中文字符

    privateStringcontent;//邮件正文

    privateStringattach;//附件,如果有的话

    privateStringtotalCount;//总发送人数

    privateStringsuccessCount;//成功发送的人数

    privateIntegerisDelete;//0不删除1删除

    privateDatecreateTime;//目前不支持定时所以创建后即刻发送

    privateSetEmailList;

    ……

    }

    其实规范是自己订的,只要团队中大家都统一遵守,统一规范,就会取得好的效果,希望对平时不加注释的朋友有点帮助。

    展开全文
  • 下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下。原则:1、注释形式统一在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,...

    代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。

    下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下。

    原则:

    1、注释形式统一

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

    2、注释内容准确简洁

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

    注释条件:

    1、基本注释(必须加)

    (a)    类(接口)的注释

    (b)    构造函数的注释

    (c)     方法的注释

    (d)    全局变量的注释

    (e)    字段/属性的注释

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

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

    (a)    典型算法必须有注释。

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

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

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

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

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

    注释格式:

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

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

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

    4、javadoc 注释标签语法

    @author   对类的说明 标明开发该类模块的作者,每个作者对应一个标签。

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

    @see     对类、属性、方法的说明 参考转向,也就是相关主题 一般ClassName是包括包名的全名

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

    @return   对方法的说明 对方法返回值的说明  一个参数对应一个标签

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

    或 @throws name description成员方法描述方法抛出的异常,每一个异常对应一个标签

    @data类/接口/方法用于显示类,方法,接口具体创建时间,或者修改时间

    @inheritDoc类/接口/成员方法继承的文档

    {@link address} 或者

    @ linkplain address text}类/接口/方法用于创建一个指向另一份文档的超链接

    @Time 2019年6月28日 22:15:22

    {@link #hashCode()}

    参考举例

    1.   类(接口)注释

    /*** 类的描述

    *@authorAdministrator

    * @Time 2012-11-2014:49:01

    **/

    public classTest extendsButton {

    ……

    }

    2.   构造方法注释

    例如:public class Test extendsButton {/*** 构造方法 的描述

    *@paramname

    *       按钮的上显示的文字*/publicTest(String name){

    ……

    }

    }

    3.   方法注释

    例如public class Test extendsButton {/*** 为按钮添加颜色

    *@paramcolor

    按钮的颜色

    *@return*@exception(方法有异常的话加)

    *@authorAdministrator

    * @Time2012-11-20 15:02:29*/publicvoidaddColor(String color){

    ……

    }

    }

    4.   全局变量注释

    public final classStringimplements java.io.Serializable, Comparable,CharSequence

    {/**The value is used for characterstorage.*/private final charvalue[];/**The offset is the first index of thestorage that is used.*/private final intoffset;/**The count is the number of charactersin the String.*/private final intcount;/**Cache the hash code for the string*/

    private int hash; //Default to 0

    ……

    }

    5.   字段/属性注释

    public class EmailBody implementsSerializable{privateString 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;//目前不支持定时 所以创建后即刻发送

    privateSetEmailList;

    ……

    }

    6.包的注释

    package-info.java -

    /*** Provides the classes necessary to create an applet and the classes an applet uses

    * to communicate with its applet context.

    *

    * The applet framework involves two entities:

    * the applet and the applet context. An applet is an embeddable window (see the

    * {@linkjava.awt.Panel} class) with a few extra methods that the applet context

    * can use to initialize, start, and stop the applet.

    *

    *@since1.0

    *@seejava.awt*/

    package java.lang.applet;

    其实规范是自己订的,只要团队中大家都统一遵守,统一规范,就会取得好的效果,希望对平时不加注释的朋友有点帮助。

    详见:https://blog.csdn.net/huangsiqian/article/details/82725214

    展开全文
  • Doxygen代码注释规范基于Doxygen的代码注释规范一、Doxygen系列软件介绍1、DoxygenDoxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。...
  • JAVA代码注释规范

    2020-10-07 16:27:11
    这里写自定义目录标题JAVA代码注释规范注释原则注释条件:1、基本注释:(必须添加)2、特殊必须加注释:注释格式: JAVA代码注释规范 注释是代码必不可少的一部分,注释提高了代码的可读性;是架起程序设计这与阅读...
  • VUE代码注释规范,代码规范

    千次阅读 2019-08-15 10:52:09
    VUE代码注释规范,代码规范 背景 其实关于这一点我是深恶痛绝呀,你说我们吧eslint开了,来敲代码,就能把你的代码给规范了吧,关于组件命名和src结构都是按照VUE目录给的(项目成员已构造),功能注释和调试代码...
  • Doxygen代码注释规范

    2015-02-06 16:30:45
    自己的编写的Doxygen代码注释规范,包括安装、使用和规范,很详细。可以直接生成.chm格式的注释文档,对于大型程序开发很有帮助。
  • 原标题:Java编程-Java代码注释规范代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在...
  • 下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下。原则:1、注释形式统一在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,...
  • git提交代码注释规范

    2018-01-12 16:24:01
    git提交代码注释规范、git提交常用操作的规范指南、[A] 新增 :(新加入的需求) [M] 修改 :( 修改或者重构代码) [D] 删除 :(删除多余的文件 ) [F] 修复 :(修复bug)
  • 本篇文章是对PHPDocument代码注释规范进行了详细的总结与介绍,需要的朋友参考下
  • Java代码注释规范

    2017-12-05 11:07:15
    Java代码注释规范
  • java代码注释规范

    2019-06-28 22:34:00
    下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下。 原则: 1、注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档...
  • 下面说一下我们在日常开发中使用的代码注释规范,供大家参考下。1、注释形式统一在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写...
  • JAVA代码注释规范codetemplates.xml,可直接导入Eclipse,代码注释效果很棒!

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 8,661
精华内容 3,464
关键字:

代码注释规范