- 浏览: 55472 次
- 性别:
- 来自: 北京
最新评论
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)。
Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种?
// 注释一行
/* ...... */ 注释若干行
不完全对,除了以上两种之外,还有第三种,文档注释:
/** ...... */ 注释若干行,并写入 javadoc 文档
注释要简单明了。
String userName = null; //用户名
边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防
止注释二义性。保持注释与其描述的代码相邻,即注释的就近原则。
对代码的注释应放在其上方相邻位置,不可放在下面。对数据结构的注释应放在
其上方相邻位置,不可放在下面;对结构中的每个域的注释应放在此域的右方;
同一结构中不同域的注释要对齐。
变量、常量的注释应放在其上方相邻位置或右方。
全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以
及存取时注意事项等的说明。
在每个源文件的头部要有必要的注释信息,包括:文件名;版本号;作者;生成日
期;模块功能描述(如功能、主要算法、内部各部分之间的关系、该文件与其它文
件关系等);主要函数或过程清单及本文件历史修改记录等。
/**
* Copy Right Information : Neusoft IIT
* Project : eTrain
* JDK version used : jdk1.3.1
* Comments : config path
* Version : 1.01
* Modification history :2003.5.1
* Sr Date Modified By Why & What is modified
* 1. 2003.5.2 Kevin Gao new
**/
在每个函数或过程的前面要有必要的注释信息,包括:函数或过程名称;功能描
述;输入、输出及返回值说明;调用关系及被调用关系说明等
/**
* Description :checkout 提款
* @param Hashtable cart info
* @param OrderBean order info
* @return String
*/
public String checkout(Hashtable htCart, OrderBean orderBean) throws Exception
{ }
javadoc注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种?
// 注释一行
/* ...... */ 注释若干行
不完全对,除了以上两种之外,还有第三种,文档注释:
/** ...... */ 注释若干行,并写入 javadoc 文档
注释要简单明了。
String userName = null; //用户名
边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防
止注释二义性。保持注释与其描述的代码相邻,即注释的就近原则。
对代码的注释应放在其上方相邻位置,不可放在下面。对数据结构的注释应放在
其上方相邻位置,不可放在下面;对结构中的每个域的注释应放在此域的右方;
同一结构中不同域的注释要对齐。
变量、常量的注释应放在其上方相邻位置或右方。
全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以
及存取时注意事项等的说明。
在每个源文件的头部要有必要的注释信息,包括:文件名;版本号;作者;生成日
期;模块功能描述(如功能、主要算法、内部各部分之间的关系、该文件与其它文
件关系等);主要函数或过程清单及本文件历史修改记录等。
/**
* Copy Right Information : Neusoft IIT
* Project : eTrain
* JDK version used : jdk1.3.1
* Comments : config path
* Version : 1.01
* Modification history :2003.5.1
* Sr Date Modified By Why & What is modified
* 1. 2003.5.2 Kevin Gao new
**/
在每个函数或过程的前面要有必要的注释信息,包括:函数或过程名称;功能描
述;输入、输出及返回值说明;调用关系及被调用关系说明等
/**
* Description :checkout 提款
* @param Hashtable cart info
* @param OrderBean order info
* @return String
*/
public String checkout(Hashtable htCart, OrderBean orderBean) throws Exception
{ }
javadoc注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
发表评论
-
java.util.SimpleDateFormat String到Date 转换
2010-09-25 10:03 927public class DataFormatCol { ... -
有关Spring AOP的概念理解
2010-07-09 10:51 6101.我所知道的aop ... -
数据库的读写分离
2010-07-09 10:34 827随着一个网站的业务不断扩展,数据不断增加,数据库的压力也会越 ... -
技术开发人员SQL规范
2010-07-09 10:25 568虽然oracle主要的工作是dba所做的事情,不过作为一个普通 ... -
接口和抽象类的区别
2010-07-06 16:21 623请说说接口和抽象类的区别?估计90%的人都答不好 我的答 ... -
java2 核心编程必须掌握的问题,看看你知道多少?
2010-07-06 16:02 656Java2 测试问题列表: 1. 什么叫作抽象? 2. ... -
一个计算机专业学生几年的编程经验汇总(四)
2010-07-06 16:00 615Java杂谈(九)--Struts2 最近 ... -
一个计算机专业学生几年的编程经验汇总(三)
2010-07-06 15:59 599Java杂谈(七)--接口& 组件、容器 ... -
一个计算机专业学生几年的编程经验汇总(二)
2010-07-06 15:58 653Java杂谈(四) 不知不觉已经写到第四篇了 ... -
一个计算机专业学生几年的编程经验汇总(一)
2010-07-06 15:57 549想来学习Java也有两个年头了,永远不敢说多么精通,但也想谈谈 ... -
完全卸载Oracle数据库的方法
2010-06-18 10:11 921很多朋友只用了Oracle的 ... -
Java面试题笔试题大全
2010-05-27 16:43 1172java面试题集 1.C++ ... -
JAVA面试题附答案(三)
2010-05-27 16:41 931101、java中会存在内存泄漏吗,请简单描述。 会。如 ... -
JAVA面试题附答案(二)
2010-05-27 16:37 84351、垃圾回收的优点 ... -
JAVA面试题附答案(一)
2010-05-27 16:31 9851、面向对象的特征有哪些方面 1.抽象: 抽象就是 ... -
Java经典面试题
2010-05-27 16:30 13171. Java中的异常处理机制 ... -
Java面试经典试题及答案
2010-05-27 16:29 1314第一,谈谈final, finally, finalize的区 ... -
Web容器和Web应用程序介绍
2010-05-27 09:40 1122http://hi.baidu.com/westsky/blo ... -
11本入门到精通J2EE书籍推荐
2010-05-14 17:00 2196这些书有的早已被业界人士强烈推荐,成为掌握EJB的必读书籍, ... -
JAVA JVM GC的工作原理
2010-05-14 16:59 1039一个优秀的Java程序员必须了解GC的工作原理、如何优化GC的 ...
相关推荐
很全的java注释规范,希望给你帮助。谢谢。
java注释规范.pdf
java程序注释的规范,每个初学者都应该掌握规范进行编程开发和学习,习惯了规范,自然就会提升代码的质量,提升团队的开发进度!
在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了...JAVA注释规范
但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个《Java的注释规范》,内容来自网络、书籍和自己的...
但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个《Java的注释规范》 一、背景 1、当我们第一次...
有关于java的注释规范的详细描述,单行注释、多行注释、分块注释等这些java的三种注释方式
JAVA相关注释规范,如:5、每行注释(连同代码)不要超过120个字(1024×768),最好不要超过80字(800×600) 。
2、怎么样避免我们的注释冗长而且凌乱不堪呢 3、在多人协同开发、维护的今天,我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢 2、 注释的简洁 内容要
java企业开发中的注释规范,方法、类、codetemplates
java命名规范以及注释规范.doc word格式 19页 讲解详细有丰富的例子
编码规范 注释规范 代码风格 华为 JAVA
JAVA代码注释规范codetemplates.xml,可直接导入Eclipse,代码注释效果很棒!
中国的程序员写的代码有一个特点,就是一千个程序员,就有一千份代码,这份JAVA注释规范提供了JAVA中注释的正确使用,为项目组也提供了规范。
程序开发过程中,良好的注释习惯会极大的提高开发的进度和系统的可维护性。
Java代码注释规范
Java开发中所要遵守的编码规范大体上有如下7点。命名规范、注释规范、缩进排版规范、文件名规范、声明规范、语句规范以及编程规范。
比较权威,规范,设计到包,方法,注释等等