java的注释规范_Java代码注释规范
1,单行(单行)-简短说明: ///...
单行注释: 代码中的单行注释. 最好在注释前有一个空行,并在其后加上与代码相同的缩进级别. 如果无法完成一行,则应使用块注释.
评论格式:
在行首注释: 在代码行首注释. 主要是使代码行毫无意义.
评论格式: //评论内容
在行尾注释: 尾随-在代码行末尾非常简短的注释. 通常在代码行后8个(至少4个)空格,所有注释必须对齐.
评论格式: 代码+ 8个(至少4个)空格+ //评论内容
2. 阻止-阻止评论:
注释几行,通常用于提供文件,方法,数据结构等的含义和目的的描述,或算法的描述. 通常位于文件或方法的前面,它起着指导作用,也可以根据需要放置在合适的位置. 此域注释不会出现在HTML报告中. 注释格式通常写为:
3. 文件注释:
注释几行并写入javadoc文档. 每个文档注释都将放置在注释定界符中
其中,注释文档将用于生成HTML格式的代码报告,因此注释文本
The
文件必须在定义类,字段,构造函数,方法和字段之前编写. 注释文档由两部分组成: 描述和块标记. 批注文档的格式如下:
公共无效doGet(HttpServletRequest请求,HttpServletResponse响应)
引发ServletException,IOException {
doPost(请求,响应);
}
前两行的说明. 描述完成后,块符号以@符号开头. 更多文档说明
有关Shihe javadoc的详细信息,请参阅javadoc主页:
4. javadoc注释标记语法
@author对类的描述表示开发该模块的作者
有关该类的@version的说明表示该类的模块的版本
通过@see参考转向(即相关主题)来描述类,属性和方法
@param对方法的描述方法中的参数说明
@return方法说明该方法返回值的说明
@exception对方法的说明解释该方法可能引发的异常
六. JAVA注释的实现
1,源文件注释
注释源文件,并且在每个源文件的开头都需要必要的注释信息,包括: 文件名;文件编号;版本号;作者;创建时间;文件描述,包括此文件的历史记录修改记录. 中文注释模板:
2. 类(模块)注释:
使用类(模块)注释. 在每个类(模块)的开头,必须包括必要的注释信息,包括: 项目名称;类(模块)号;命名空间该类可以运行的JDK版本;版本号;作者;创建时间;类(模块)的功能描述(例如功能,主要算法,内部部件之间的关系,此类与其类之间的关系等),必要时必须有一些特殊的软硬件要求等说明;此类(模块)的主要功能或过程列表以及历史修改记录.
英语注释模板:
如果模块仅修改少量代码,则每次修改都必须添加以释:
//重写器
//重写日期: 开始1:
// End1:
注释掉原始代码的内容,然后使用以释添加新代码:
//添加人
//添加日期: jsp代码注释,格式: YYYY-MM-DD>开始2:
// End2:
如果模块的输入和输出参数或功能结构有重大修改,则每次修改都必须添加以下内容
评论:
//日志ID:
//描述:
//作家: 修饰语的中文名称
//重写日期:
2. 界面说明:
使用接口注释. 基于令人满意的类批注,接口批注应包含有关接口用途,应如何使用以及不应如何使用的描述. 方框标记必须指明作者和版本. 在清除接口注释的前提下,可以不注释相应的实现类.
3. 构造说明:
构造函数注释使用,描述部分指示构造函数的作用,并且不一定有块标记.
注释模板1:
评论模板二:
4. 功能说明:
使用功能注释. 在每个功能或过程之前,必须有必要的注释信息,包括: 功能或过程名称;功能说明;输入,输出和返回值说明;调用关系和被调用关系描述等. 版本号(@version)可能不会出现在函数注释中.
注释模板1:
评论模板二:
5. 方法说明:
采用方法注释. 对于设置(Set方法)和获取(Get方法)成员的方法,在解释了成员变量后,不能添加任何注释;需要普通的成员方法来说明完成了什么功能,参数的含义是什么,返回值是什么;此外,必须清楚说明该方法的创建时间,以为将来的维护和阅读提供有价值的线索.
6. 该方法的内部注释:
控制结构,代码的功能以及执行的原因,处理顺序等. 尤其对于复杂的逻辑处理部分,应尽可能给出详细的注释.
7. 全局变量注释:
更详细的注释,包括对其功能,值范围,访问的功能或过程的说明,以及访问期间的注意事项等.
8. 局部(中间)变量注释:
必须对主要变量进行注释,如果没有特殊含义jsp代码注释,可以不加注释.
9. 实际参数/参数说明:
参数含义以及任何其他约束或前提条件.
10. 字段/属性注释: 字段描述,属性描述.
11. 常量: 常量通常具有一定的实际意义,必须定义相应的描述.
本文来自电脑杂谈,转载请注明本文网址:
http://www.pc-fly.com/a/jisuanjixue/article-254359-1.html
java的注释规范_Java代码注释规范相关推荐
- java代码开发规范_java代码开发规范
一 编码规范 1.1 命名规范 代码中的命名均不能以特殊字符(如下划线.$#符号)开始或结束. 反例: _name / #Object 2. 代码中的命名严禁使用拼音与英文混合的方式,更不 ...
- Eclipse配置代码注释模板 Eclipse代码注释模板 Eclipse设置方法注释模板
Eclipse配置代码注释模板 Eclipse代码注释模板 Eclipse设置方法注释模板 一.前言 1.在日常的团队开发中,都会有相应的的代码开发规范模板:在不同的IDE中配置方式又是不一样的,本文 ...
- java dao层编写及注释_JAVA代码注释规范
2. 班级: 班级的目的,即班级完成的功能,以及班级的创建时间和作者姓名:当多个人一次编辑或修改同一个班级时, 作者姓名中应出现多个姓名: 3. 接口: 在满足类注释的基础上,接口注释应包含设置接口的 ...
- java 注释 超链接_java_Java代码注释规范详解,代码附有注释对程序开发者来 - phpStudy...
Java代码注释规范详解 代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用. 基本的要求: 1.注释形式统一 在整个应 ...
- java类注释 写作规范_Java标准注释及规范
JAVA注释技巧 1.空行和空白字符也是一种特殊注释.利用缩进和空行,使代码与注释容易区 别,并协调美观. 2.当代码比较长,特别是有多重嵌套时,为了使层次清晰,应当在一些段落的 结束处加注释(在闭合 ...
- java 代码注释_Java代码注释
通过代码注释,可提高程序的可读性.注释中包含了程序的信息,可以帮助从程序员更好的阅读和理解程序.Java源文件的任意位置都可以添加注释语句.注释的文字Java编译器不进行编译,所有代码中的注释文字对程 ...
- 是雏还是鹰mdash;mdash;编程规范之代码注释
注释能使代码更加容易理解,更加容易跟踪.出色的注释就像一幅好的设计蓝图,能够引导阅读者通过你的应用程序的曲折之处,能够说明预期的运行结果和可能出现的异常情况.注释可以为后来的维护者带来极大的方便,无论 ...
- java 代码书写规范_代码书写规范和命名规范
上一篇给大家分享了一下,关于文档编写的几个概念.这篇文章阐述如果编写代码书写规范以及命名规范文档.[以java语言为例] 1.代码书写规范 代码书写规范,能够让不同的人,写出相同风格的代码.很多人都看 ...
- java单元测试规范_Java单元测试编码规范
包结构规范 单元测试包结构和源码结构必须保持一致,如下图所示: 文件命名规范 单元测试文件名字是由"被测试文件名 + Test"组成,如下图所示 代码编写规范 基础单元测试类 被各 ...
最新文章
- Numpy入门教程:06. 排序,搜索和计数
- Linux基础——bash基础应用及文件系统基础命令
- 数据库复习总结(12)数据检索
- 成功解决AttributeError: module 'tensorflow' has no attribute 'scalar_summary'
- boost::serialization模块测试 auto_ptr 序列化的测试程序
- 支援 Chrome 插件:微软 Chromium 内核 Edge 浏览器可以下载啦!
- bash 的环境配置文件
- 心大于物 ----论意识心灵与物理大脑的关系
- 递归与递推类型题小结
- 中文版开源!这或许是最经典的 Python 编程教材
- uva 11732 strcmp() Anyone?
- linux配置文件前面有分号,linux中的分号 ||
- 网络表情NLP(一)︱颜文字表情实体识别、属性检测、新颜发现
- 小偷电竞酒店换显卡被抓!网吧/电竞酒店如何防盗?
- 游戏 csp 201712-2
- php开发中常用字符串函数总结
- 关于技术学习的一点思考
- 【报错】fatal: unable to access
- 给希望成为游戏美术设计师的朋友
- 修改首页轮播后台(php)
热门文章
- (三)构建模块——Web页面建设
- Python学习入门基础教程(learning Python)--3.3.1 Python下的布尔表达式
- 单机杀毒软件仅是企业信息安全的时尚毛衣
- 网络管理员&MCSE2003之12: 第8章 应用管理模板和审核策略
- 关于个别网段上网时断时续的问题解决
- CSS3 @font-face 规则
- JS显示document里所有的成员
- CSS布局 ——从display,position, float属性谈起
- 【Android开发】自定义ListView,使用通用适配器,并实现ListView上的每一项和每一项上的按钮等控件同时监听
- 二叉树的序列化与反序列化