JAVA代码注释规范

Java类注释规范
最新推荐文章于 2024-04-15 14:17:57 发布
转载 最新推荐文章于 2024-04-15 14:17:57 发布 · 558 阅读 · 0

本文详细介绍了Java类文件的各种注释规范，包括类文件注释、类功能注释、类变量注释、类方法注释及方法内代码块注释等，提供了丰富的示例帮助理解和应用。

转载地址

 

整个类文件注释 
示例如下: 
Java代码
  1. /*
  3. * @(#)Object.java      1.61 03/01/23
  5. *
  7. * Copyright 2003 Sun Microsystems, Inc. All rights reserved.
  9. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
  11. */  
  12.   
  13.   
  14.   
  15. package java.lang;  
[java]  view plain  copy
  1. /* 
  2.  
  3.  * @(#)Object.java     1.61 03/01/23 
  4.  
  5.  * 
  6.  
  7.  * Copyright 2003 Sun Microsystems, Inc. All rights reserved. 
  8.  
  9.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. 
  10.  
  11.  */  
  12.   
  13.    
  14.   
  15. package java.lang;  
注释结构:
  1. /*
  3. * @(#){类名称}.java        {创建时间}
  5. *
  7. * {某人或某公司具有完全的版权}
  9. * {使用者必须经过许可}
  11. */  
  12.   
  13.   
  14.   
  15. package java.lang;   
  16.   
  17.    
[java]  view plain  copy
  1. /* 
  2.  
  3.  * @(#){类名称}.java       {创建时间} 
  4.  
  5.  * 
  6.  
  7.  * {某人或某公司具有完全的版权} 
  8.  
  9.  * {使用者必须经过许可} 
  10.  
  11.  */  
  12.   
  13. package java.lang;  
2. 具体类功能注释 

示例如下: 
Java代码
  1. /**
  3. * Class <code>Object</code> is the root of the class hierarchy.
  5. * Every class has <code>Object</code> as a superclass. All objects,
  7. * including arrays, implement the methods of this class.
  9. *
  11. * @author   unascribed
  13. * @version 1.61, 01/23/03
  15. * @see      java.lang.Class
  17. * @since    JDK1.0
  19. */  
  20.   
  21. public class Object {}   
  22.   
  23.    
[java]  view plain  copy
  1. /** 
  2.  
  3.  * Class <code>Object</code> is the root of the class hierarchy. 
  4.  
  5.  * Every class has <code>Object</code> as a superclass. All objects, 
  6.  
  7.  * including arrays, implement the methods of this class. 
  8.  
  9.  * 
  10.  
  11.  * @author  unascribed 
  12.  
  13.  * @version 1.61, 01/23/03 
  14.  
  15.  * @see     java.lang.Class 
  16.  
  17.  * @since   JDK1.0 
  18.  
  19.  */  
  20.   
  21. public class Object {}  
注释结构: 
Java代码
  1. /**
  3. * 类 <code>{类名称}</code>{此类功能描述}
  5. *
  7. * @author   {作者}
  9. * @version {版本,常用时间代替}
  11. * @see      java.lang.Class
  13. * @since    JDK{jdk版本}
  15. */  
  16.   
  17. public class Object {}   
  18.   
  19.    
[java]  view plain  copy
  1. /** 
  2.  
  3.  * 类 <code>{类名称}</code>{此类功能描述} 
  4.  
  5.  * 
  6.  
  7.  * @author  {作者} 
  8.  
  9.  * @version {版本,常用时间代替} 
  10.  
  11.  * @see     java.lang.Class 
  12.  
  13.  * @since   JDK{jdk版本} 
  14.  
  15.  */  
  16.   
  17. public class Object {}  
3. 类变量注释 

示例如下: 
Java代码
  1. /** The value is used for character storage. */  
  2.   
  3. private char value[];   
  4.   
  5.    
[java]  view plain  copy
  1. /** The value is used for character storage. */  
  2.   
  3.  private char value[];  
注释结构: 
Java代码
  1. /** {此值是用来存储/记录什么的}*/  
  2.   
  3. private String str ;   
[java]  view plain  copy
  1. /** {此值是用来存储/记录什么的}*/  
  2.   
  3.  private String str ;  
4. 类方法注释 

示例如下: 
Java代码
  1.     /**
  3.       * Returns a new string that is a substring of this string. The
  5.       * substring begins with the character at the specified index and
  7.       * extends to the end of this string. <p>
  9.       * Examples:
  11.       * <blockquote><pre>
  13.       * "unhappy".substring(2) returns "happy"
  15.       * "Harbison".substring(3) returns "bison"
  17.       * "emptiness".substring(9) returns "" (an empty string)
  19.       * </pre></blockquote>
  21.       *
  23.       * @param       beginIndex    the beginning index, inclusive.
  25.       * @return      the specified substring.
  27.       * @exception   IndexOutOfBoundsException   if
  29.       *              <code>beginIndex</code> is negative or larger than the
  31.       *              length of this <code>String</code> object.
  33.       */  
  34.   
  35. public String substring(int beginIndex) {   
  36.   
  37. return substring(beginIndex, count);   
  38.   
  39. }   
  40.   
  41.    
[java]  view plain  copy
  1. /** 
  2.  
  3.      * Returns a new string that is a substring of this string. The 
  4.  
  5.      * substring begins with the character at the specified index and 
  6.  
  7.      * extends to the end of this string. <p> 
  8.  
  9.      * Examples: 
  10.  
  11.      * <blockquote><pre> 
  12.  
  13.      * "unhappy".substring(2) returns "happy" 
  14.  
  15.      * "Harbison".substring(3) returns "bison" 
  16.  
  17.      * "emptiness".substring(9) returns "" (an empty string) 
  18.  
  19.      * </pre></blockquote> 
  20.  
  21.      * 
  22.  
  23.      * @param      beginIndex   the beginning index, inclusive. 
  24.  
  25.      * @return     the specified substring. 
  26.  
  27.      * @exception  IndexOutOfBoundsException  if 
  28.  
  29.      *             <code>beginIndex</code> is negative or larger than the 
  30.  
  31.      *             length of this <code>String</code> object. 
  32.  
  33.      */  
  34.   
  35. public String substring(int beginIndex) {  
  36.   
  37. return substring(beginIndex, count);  
  38.   
  39. }  
注释结构: 
Java代码
  1.     /**
  3.       * {方法的功能/动作描述}
  5.       *
  7.       * @param       {引入参数名}    {引入参数说明}
  9.       * @return       {返回参数名}    {返回参数说明}
  11.       * @exception    {说明在某情况下,将发生什么异常}
  13.       */  
  14.   
  15. public String substring(int beginIndex) {   
  16.   
  17. return substring(beginIndex, count);   
  18.   
  19. }   
  20.   
  21.    
[java]  view plain  copy
  1. /** 
  2.  
  3.      * {方法的功能/动作描述} 
  4.  
  5.      * 
  6.  
  7.      * @param      {引入参数名}   {引入参数说明} 
  8.  
  9.      * @return      {返回参数名}   {返回参数说明} 
  10.  
  11.      * @exception   {说明在某情况下,将发生什么异常} 
  12.  
  13.      */  
  14.   
  15. public String substring(int beginIndex) {  
  16.   
  17. return substring(beginIndex, count);  
  18.   
  19. }  
5.     类方法中代码块注释 

示例如下: 
Java代码
  1. /*
  3. * 调用持久化类，将数据保存到库
  5. *
  7. * 判断是添加，还是修改
  9. */  
  10.   
  11. boolean ifSucc = false;   
  12.   
  13. if(request.getParameter("YINGLI_ID")==null){   
  14.   
  15.         String GUID = new RandomGUID().toString();   
  16.   
  17.         stressTestDataBean.setUSER_ID(Integer.toString(userId));   
  18.   
  19.         stressTestDataBean.setSIGN_ISBN((String)vSectNum.get(0));   
  20.   
  21.         stressTestDataBean.setSHENHE_JIEGUO("0");   
  22.   
  23.         stressTestDataBean.setGUID(GUID);   
  24.   
  25.         stressTestDataBean.setCREATE_DATE("getdate()");   
  26.   
  27.         stressTestDataBean.setSTATE("A");   
  28.   
  29.                                             
  30.   
  31.         ifSucc = StressTestDataDao.addStressTestData(db,stressTestDataBean);   
  32.   
  33. }else{   
  34.   
  35.         ifSucc = StressTestDataDao.mendStressTestData(db,stressTestDataBean);   
  36.   
  37. }   
  38.   
  39.    
[java]  view plain  copy
  1. /* 
  2.  
  3. * 调用持久化类，将数据保存到库 
  4.  
  5. * 
  6.  
  7. * 判断是添加，还是修改 
  8.  
  9. */  
  10.   
  11. boolean ifSucc = false;  
  12.   
  13. if(request.getParameter("YINGLI_ID")==null){  
  14.   
  15.        String GUID = new RandomGUID().toString();  
  16.   
  17.        stressTestDataBean.setUSER_ID(Integer.toString(userId));  
  18.   
  19.        stressTestDataBean.setSIGN_ISBN((String)vSectNum.get(0));  
  20.   
  21.        stressTestDataBean.setSHENHE_JIEGUO("0");  
  22.   
  23.        stressTestDataBean.setGUID(GUID);  
  24.   
  25.        stressTestDataBean.setCREATE_DATE("getdate()");  
  26.   
  27.        stressTestDataBean.setSTATE("A");  
  28.   
  29.                                            
  30.   
  31.        ifSucc = StressTestDataDao.addStressTestData(db,stressTestDataBean);  
  32.   
  33. }else{  
  34.   
  35.        ifSucc = StressTestDataDao.mendStressTestData(db,stressTestDataBean);  
  36.   
  37. }  
注释结构: 
Java代码
  1. /*
  3. * {功能描述}
  5. *
  7. * {具体实现动作}
  9. */  
  10.   
  11. boolean ifSucc = false;   
  12.   
  13. if(request.getParameter("YINGLI_ID")==null){   
  14.   
  15.         String GUID = new RandomGUID().toString();   
  16.   
  17.         stressTestDataBean.setUSER_ID(Integer.toString(userId));   
  18.   
  19.         stressTestDataBean.setSIGN_ISBN((String)vSectNum.get(0));   
  20.   
  21.         stressTestDataBean.setSHENHE_JIEGUO("0");   
  22.   
  23.         stressTestDataBean.setGUID(GUID);   
  24.   
  25.         stressTestDataBean.setCREATE_DATE("getdate()");   
  26.   
  27.         stressTestDataBean.setSTATE("A");   
  28.   
  29.                                             
  30.   
  31.         ifSucc = StressTestDataDao.addStressTestData(db,stressTestDataBean);   
  32.   
  33. }else{   
  34.   
  35.         ifSucc = StressTestDataDao.mendStressTestData(db,stressTestDataBean);   
  36.   
  37. }  
cs06161118
关注
IntelliJ IDEA 中的 Java 代码注释规范
欢迎来到我的优快云空间！这里聚焦AI大模型应用实战，分享前沿技术、实战案例与开发经验。
04-06 826
在软件开发过程中，代码注释是不可或缺的一部分。良好的代码注释能够提高代码的可读性、可维护性，方便团队成员之间的协作和交流。本文的目的是详细介绍在 IntelliJ IDEA 这个强大的 Java 集成开发环境中，如何遵循一套规范的 Java 代码注释方法。范围涵盖了 Java 代码中常见的各种注释类型，包括文档注释、行注释和块注释，以及如何在不同的场景下合理使用这些注释。本文将按照以下结构进行阐述：首先介绍 Java 代码注释的核心概念与联系，让读者对不同类型的注释有一个清晰的认识；
JAVA代码注释规范codetemplates.xml
01-26
JAVA代码注释规范codetemplates.xml，可直接导入Eclipse,代码注释效果很棒！
java代码注释规范
热门推荐
shiyuezhong的专栏
11-20 19万+
代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在诉求网二期开发中使用的代码注释规范，供大家参考下。 原则： 1、注释形式统一 在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的
java代码注释规范文档
09-18
后端开发技术的代码注释规范 单行注释 多行注释 块注释 文档注释 标签注释等等
java注释模版（java-code style-codetemplate）
02-24
java注释模版,使程序运行更让人容易看懂，和理解，加快速度
Java 注释
weixin_30550081的博客
11-18 404
Java 注释 标签 : Java基础 五月份得知入职阿里云OS, 才开始学Java, 断断续续学习/使用半年, 越来越喜欢这个语言/工具. 后来被拥抱变化之后, 拿到的大部分offer是Java服务端研发; 一路走来, 踩了很多坑, 也有了一点小小的心得, 而且博客已经停更几个月, 今天就以博客形式把他记录下来吧. 2015下半年第一篇博客, 从最基础的...
Android:Eclipse如何设置格式化Java代码
huluhong的博客
05-12 1048
为了避免截图，从另外一篇文章中抄来了图片：http://www.avajava.com/tutorials/lessons/how-do-i-create-a-profile-to-format-java-code-in-eclipse.html?page=2 1. 首先创建一个新的格式化Profile 菜单 Window → Preferences 选择Java → Code Sty
Java代码注释规范(动力节点整理)
08-30
Java代码注释规范是编程实践中不可或缺的一部分，它有助于提高代码的可读性和团队协作效率。以下是一些关于Java代码注释的基本原则和建议： 1. **注释形式统一**： - 在整个代码库中，应保持注释风格的一致性。这...
Java代码注释规范.docx
05-09
【Java代码注释规范】 Java代码注释规范是软件开发中的一个重要组成部分，它不仅有助于提升代码的可读性和可维护性，还能增强团队间的协作效率。遵循良好的编码规范，可以帮助开发者形成良好的编程习惯，培养更加...
Java代码注释规范详解
09-02
Java代码注释是编程实践中不可或缺的一部分，它有助于提高代码的可读性和维护性。下面将详细阐述Java代码注释的一些规范和最佳实践。 1. **注释形式统一**： - 保持一致性是关键。在同一个项目中，注释应该采用...
java注释规范_Java代码注释规范详解
weixin_34377697的博客
02-12 2423
代码附有注释对程序开发者来说非常重要，随着技术的发展，在项目开发过程中，必须要求程序员写好代码注释，这样有利于代码后续的编写和使用。基本的要求：1、注释形式统一在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。2、注释内容准确简洁内容要简单、明了、含义准确，防止注释的多义性，错误...
Java开发手册之注释规约
m0_75232472的博客
04-15 753
在开头跟大家分享的时候我就说，面试我是没有做好准备的，全靠平时的积累，确实有点临时抱佛脚了，以至于我自己还是挺懊恼的。（准备好了或许可以拿个40k，没做准备只有30k+，你们懂那种感觉吗）如何准备面试？1、前期铺垫（技术沉积）程序员面试其实是对于技术的一次摸底考试，你的技术牛逼，那你就是大爷。大厂对于技术的要求主要体现在：基础，原理，深入研究源码，广度，实战五个方面，也只有将原理理论结合实战才能把技术点吃透。
java 注释 代码_java注释代码规范
weixin_34369657的博客
02-12 165
//收集了一小部分，忘记的时候过来查一下java--hadoop部分/*** 此类用来处理DNS原始日志：统计给定域名平均响应时延*@paramInput*@paramOutput*@paramcacheUriListfilePath*@paramcacheIpNetTypefilePath* [文件cachefile需要上传HDFS,文件为K-V形式,多个V用;隔开]** NOTE:该类适合限定...
java if 规范_Java if else分支结构精讲
weixin_39603588的博客
03-04 655
Java 支持两种选择语句：if 语句和 switch 语句。其中 if 语句使用布尔表达式或布尔值作为分支条件来进行分支控制，而 switch 语句则用于对多个整型值进行匹配，从而实现分支控制。这些语句允许你只有在程序运行时才能知道其状态的情况下，控制程序的执行过程。如果你没有 C/C++ 的编程背景，你将会为这两个语句的强大功能和灵活性而感到吃惊。选择结构(也叫分支结构)解决了顺序结构不能判断...
java注释详解_Java文档注释详解
weixin_29053383的博客
02-12 1007
一.javadoc1.简述对于Java语言，最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程序的文档化问题。对于程序的文档化，最大的问题 莫过于对文档的维护。若文档与代码分离，那么每次改变代码后都要改变文档，这无疑会变成相当麻烦的一件事情。解决的方法看起来似乎很简单：将代码同文档 “链接”起来。为达到这个目的，最简单的方法是将所有内容都置于同一个文件。然而，为使一切都整...
Java注释规范
u010490755的博客
12-15 302
代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在诉求网二期开发中使用的代码注释规范，供大家参考下。 原则： 1、注释形式统一 在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规
【Java】Java注释 - 单行、块、文档注释
渐若窥宏大的博客
11-23 2184
简单记录，Java 核心技术卷I 基础知识（原书第10 版） 注释 我们在编写程序时，经常需要添加一些注释，用来描述某段代码的作用，提高Java源程序代码的可读性，使得Java程序条理清晰。 写代码的时候应遵循注意一些java规范，函数短小精悍，用清晰的命名来解释代码， 整洁的代码， 不要保留不用的代码（注释代码），要么删掉，要么想到更好的方案替换，别留着，注释不要写废话和错误的。 那为什么要写注...
阿里java代码注释规范
最新发布
04-03
### 阿里巴巴 Java 代码注释规范 在阿里巴巴的 Java 开发编码规范中，对于代码注释的要求非常严格，目的是为了提高代码可读性和维护性。以下是关于注释的一些具体规定： #### 单行注释 单行注释应以 `//` 开头，并且与被注释的内容保持一定的逻辑关系。如果注释内容较长，可以将其单独放在一行上[^1]。 ```java int a = 1; // 对于简单的变量定义，可以在同一行写明含义 // 如果注释较为复杂或者需要解释更多细节，则建议将注释独立成一行 String message = "Hello, world!"; ``` #### 多行注释 多行注释应当使用 `/* */` 的形式包裹起来。当一段代码的功能较复杂时，应在该段代码之前添加详细的说明。 ```java /* * 下面的方法用于计算两个整数的最大公约数。 * 参数 a 和 b 表示待比较的两个正整数。 */ public static int gcd(int a, int b) { while (b != 0) { int temp = a % b; a = b; b = temp; } return a; } ``` #### 类和方法的文档注释 类、接口以及公共方法都必须提供 Javadoc 文档注释。这些注释应该清晰描述其功能、参数意义及其返回值等信息。 ```java /** * 此类表示一个简单的计算器工具，支持基本运算操作。 * * @author Your Name * @version 1.0 */ public class Calculator { /** * 计算两数之和。 * * @param num1 加数一 * @param num2 加数二 * @return 返回相加之和 */ public double add(double num1, double num2) { return num1 + num2; } } ``` #### 特殊情况下的 TODO 注释 对于尚未完成的部分或是存在潜在问题的地方，可以通过 `TODO` 来标记提醒开发者后续处理。 ```java // TODO: 当前实现仅适用于非负整数场景，需扩展至任意实数范围 if (number >= 0) { result = Math.sqrt(number); } else { throw new IllegalArgumentException("Negative numbers are not supported."); } ```
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值