文档下载 文档下载导航
设为首页 | 加入收藏
搜索 请输入内容:  
 导航当前位置: 文档下载 > 所有分类 > IT/计算机 > 计算机软件及应用 > Java注释规范
侵权投诉

Java注释规范

Java注释规范,很详细,很有用。

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

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

//Writer:修改者中文名

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

3、接口注释:

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

4、构造函数注释:

构造函数注释采用 /** …… */,描述部分注明构造函数的作用,不一定有块标记部分。 注释模版一:

/**

* 默认构造函数

*/

注释模版二:

/**

* Description : 带参数构造函数,

* 初始化模式名,名称和数据源类型

* @param schema: 模式名

* @param name: 名称

* @param type: 数据源类型

*/

5、函数注释:

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

注释模版一:

/**

* 函 数 名 :

* 功能描述:

上一页第7页

热门文档

相关文档

  • Java注释规范整理

    Java注释规范整理_IT/计算机_专业资料。Java注释规范Java 注释规范一、背景 1、当我们第一次接触某段代码,但又被要求在极短的时间内有效地分 析这段代码,我们...

  • java注释书写规范

    java注释书写规范_IT/计算机_专业资料。Java 注释书写规范 Javadoc 是 Sun 公司提供的一个技术,它从程序源代码中抽取类、方法、成 员等注释形成一个和源代码...

  • java注释规范

    java注释规范_IT/计算机_专业资料。javadoc 做注释 一. Java 文档 // 注释一行 /* ... */ 注释若干行 /** ... */ 注释若干行,并写入 javadoc 文档...

  • java注释规范

    java注释规范_IT/计算机_专业资料。JAVA注释规范设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开 Comments 节点就是所有需设置...

  • Java注释规范

    Java注释规范_电子/电路_工程科技_专业资料。Java的各种注释,以及写入Javadoc的注释要求对于Java 注释我们主要了解两种: // 注释一行 /* ... */ 注释若干行...

  • java注释规范

    java注释规范_工学_高等教育_教育专区。Java 程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。 实现注释:/*…*/和//,用以注释...

  • java中的注释规范

    java中的注释规范_IT/计算机_专业资料。java中的注释规范JAVA 注释方法及格式 1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释...

  • javadoc注释规范

    javadoc注释规范_专业资料。javadoc注释规范javadoc 做注释 一. Java 文档 // 注释一行 注释若干行 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法...

  • 注释模板规范_java

    注释模板规范_java_计算机软件及应用_IT/计算机_专业资料。关于java注释模板规范设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后...

站点地图 | 文档上传 | 侵权投诉 | 手机版
本站所有资源均来自互联网,本站只负责收集和整理,均不承担任何法律责任,如有侵权等其它行为请联系我们.
文档下载 Copyright 2013 doc.guandang.net All Rights Reserved.  -  email