JAVA代码注释规范

最新推荐文章于 2025-04-29 16:20:10 发布
最新推荐文章于 2025-04-29 16:20:10 发布
阅读量1.9w 收藏 15
点赞数 3
文章标签： java string character exception class arrays

转载地址

 

整个类文件注释

示例如下:
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;   
/*

 * @(#)Object.java     1.61 03/01/23

 *

 * Copyright 2003 Sun Microsystems, Inc. All rights reserved.

 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

 */

 

package java.lang;
注释结构:
  1. /*
  3. * @(#){类名称}.java        {创建时间}
  5. *
  7. * {某人或某公司具有完全的版权}
  9. * {使用者必须经过许可}
  11. */  
  12.   
  13.   
  14.   
  15. package java.lang;   
  16.   
  17.     
/*

 * @(#){类名称}.java       {创建时间}

 *

 * {某人或某公司具有完全的版权}

 * {使用者必须经过许可}

 */

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.     
/**

 * Class <code>Object</code> is the root of the class hierarchy.

 * Every class has <code>Object</code> as a superclass. All objects,

 * including arrays, implement the methods of this class.

 *

 * @author  unascribed

 * @version 1.61, 01/23/03

 * @see     java.lang.Class

 * @since   JDK1.0

 */

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.     
/**

 * 类 <code>{类名称}</code>{此类功能描述}

 *

 * @author  {作者}

 * @version {版本,常用时间代替}

 * @see     java.lang.Class

 * @since   JDK{jdk版本}

 */

public class Object {}
3. 类变量注释

示例如下:
Java代码
  1. /** The value is used for character storage. */  
  2.   
  3. private char value[];   
  4.   
  5.     
/** The value is used for character storage. */

 private char value[];
注释结构:
Java代码
  1. /** {此值是用来存储/记录什么的}*/  
  2.   
  3. private String str ;    
/** {此值是用来存储/记录什么的}*/

 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.     
/**

     * Returns a new string that is a substring of this string. The

     * substring begins with the character at the specified index and

     * extends to the end of this string. <p>

     * Examples:

     * <blockquote><pre>

     * "unhappy".substring(2) returns "happy"

     * "Harbison".substring(3) returns "bison"

     * "emptiness".substring(9) returns "" (an empty string)

     * </pre></blockquote>

     *

     * @param      beginIndex   the beginning index, inclusive.

     * @return     the specified substring.

     * @exception  IndexOutOfBoundsException  if

     *             <code>beginIndex</code> is negative or larger than the

     *             length of this <code>String</code> object.

     */

public String substring(int beginIndex) {

return substring(beginIndex, count);

}
注释结构:
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.     
/**

     * {方法的功能/动作描述}

     *

     * @param      {引入参数名}   {引入参数说明}

     * @return      {返回参数名}   {返回参数说明}

     * @exception   {说明在某情况下,将发生什么异常}

     */

public String substring(int beginIndex) {

return substring(beginIndex, count);

}
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.     
/*

* 调用持久化类，将数据保存到库

*

* 判断是添加，还是修改

*/

boolean ifSucc = false;

if(request.getParameter("YINGLI_ID")==null){

       String GUID = new RandomGUID().toString();

       stressTestDataBean.setUSER_ID(Integer.toString(userId));

       stressTestDataBean.setSIGN_ISBN((String)vSectNum.get(0));

       stressTestDataBean.setSHENHE_JIEGUO("0");

       stressTestDataBean.setGUID(GUID);

       stressTestDataBean.setCREATE_DATE("getdate()");

       stressTestDataBean.setSTATE("A");

                                         

       ifSucc = StressTestDataDao.addStressTestData(db,stressTestDataBean);

}else{

       ifSucc = StressTestDataDao.mendStressTestData(db,stressTestDataBean);

}
注释结构:
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. }  

allenlee
关注
IntelliJ IDEA 中的 Java 代码注释规范
欢迎来到我的优快云空间！这里聚焦AI大模型应用实战，分享前沿技术、实战案例与开发经验。
04-06 667
在软件开发过程中，代码注释是不可或缺的一部分。良好的代码注释能够提高代码的可读性、可维护性，方便团队成员之间的协作和交流。本文的目的是详细介绍在 IntelliJ IDEA 这个强大的 Java 集成开发环境中，如何遵循一套规范的 Java 代码注释方法。范围涵盖了 Java 代码中常见的各种注释类型，包括文档注释、行注释和块注释，以及如何在不同的场景下合理使用这些注释。本文将按照以下结构进行阐述：首先介绍 Java 代码注释的核心概念与联系，让读者对不同类型的注释有一个清晰的认识；
Java代码注释模板
09-18
为便于规范各位开发人员代码、提高代码质量，研发中心需要启动代码评审机制。为了加快代码评审的速度，减少不必要的时间，可以加入一些代码评审的静态检查工具，另外需要为研发中心配置统一的编码模板和代码格式化模板。
Java中entity（实体类）的写法规范
ATCO[这里，只是顺手插曲]
07-15 8971
在日常的Java项目开发中，entity（实体类,pojo）是必不可少的，它们一般都有很多的属性，并有相应的setter和getter方法。entity（实体类）的作用一般是和数据表做映射。所以快速写出规范的entity（实体类）是java开发中一项必不可少的技能。 　　在项目中写实体类一般遵循下面的规范： 　　　　1、根据你的设计，定义一组你需要的私有属性。 　　　　2、根据这些属
Java 注释规范
最新发布
cici15874的博客
04-29 311
Java中的注释规范主要遵循几种不同的注释类型，每种类型适用于不同的场景。遵循这些规范可以帮助提高代码的可读性和可维护性。
java注释
夜影鬼手的专栏
03-29 423
JAVA 方法或者类的注释快捷键/** * 说明 * @author 123 * */这种注释效果方法： 1、先敲“/”在敲两个**，然后回车,方法上面方法： 2、alt+shift+J 类上面注释的快捷键//hhah//sjsj添加 注释 Ctrl+Shift+/,去除注释的快捷键是Ctrl+Shift+\...
Java 标准注解和元注解
glb168的博客
01-06 1155
一文了解Java标准注解override、Deprecated、SuppressWarnings，元注解Target、Retention、Documented、Inherited、Repeatable、Native，及其使用。
java代码注释示例_一个简单的Java程序例子以及其几种注释
weixin_36254564的博客
02-13 779
在说道主题前，先来啰嗦两句，o()︿︶)o 唉，不说两句心里就有个疙瘩，也许这就是所谓的强迫症吧，好了说说我想啰嗦的，其实也就是这样子的，关于Java开发工具箱的下载以及环境的配置。Java开发工具箱的下载进入到oracle官网下载即可(具体的步骤就不赘述了如今网络资源丰富你懂得)，下载好之后然后开始安装，根据安装过程中的说明进行下一步直至完成即可，等等不要激动，还没完了，要开始配置Java的开发...
Java代码注释规范(动力节点整理)
08-30
Java代码注释规范是编程实践中不可或缺的一部分，它有助于提高代码的可读性和团队协作效率。以下是一些关于Java代码注释的基本原则和建议： 1. **注释形式统一**： - 在整个代码库中，应保持注释风格的一致性。这...
Java代码注释规范.docx
05-09
【Java代码注释规范】 Java代码注释规范是软件开发中的一个重要组成部分，它不仅有助于提升代码的可读性和可维护性，还能增强团队间的协作效率。遵循良好的编码规范，可以帮助开发者形成良好的编程习惯，培养更加...
Java代码注释规范详解
09-02
Java代码注释是编程实践中不可或缺的一部分，它有助于提高代码的可读性和维护性。下面将详细阐述Java代码注释的一些规范和最佳实践。 1. **注释形式统一**： - 保持一致性是关键。在同一个项目中，注释应该采用...
java代码注释规范文档
09-18
### Java代码注释规范知识点详解 #### 一、概述 在软件开发过程中，良好的注释习惯对于提升代码可读性、可维护性至关重要。本文档旨在详细介绍Java代码中的各种注释方式及其应用场合，帮助开发者形成一致且有效的...
Java代码、注释模版格式文件
04-12
Java代码、注释模版格式文件
Java代码注释
weixin_30765505的博客
12-15 71
单行注释： 选中代码，按下ctrl+/ 一条代码单行注释：选中一条代码按下ctrl+/，则为一条代码单行注释； 多条代码单行注释：选中多条代码按下ctrl+/，则为多条代码单行注释； 取消注释：对已经注释好的代码选中再次按下ctrl+/，则取消注释。 1 public class PrintDemo { 2 3 public static void main(St...
java代码注释
Aaron_Tang_的博客
02-18 361
定义：java代码的注释就是备注功能：为了提高代码的可读性分类：单行注释、多行注释、文档注释单行注释：就是指只注释一段代码比如：int number;//定义一个整型变量多行注释：一次性注释多行代码比如：/*int i = 10;double money = 12.9;*/文档注释：文档注释可以被javadoc工具读取出来并形成程序文档的注释格式。比如：/**注释内容*/总结：代码的注释，简单来说...
Java注释和真实世界的Spring示例
最佳 Java 编程
05-07 130
“注释”是编程语言定义的一种，用作“标记”。 可以将它们视为编程语言引擎可以理解的注释行。 它们不会直接影响程序的执行，但是会在需要时间接影响。 定义 注释使用@interface关键字定义，并且与接口相似。 它具有定义类似于接口方法的属性。 属性可以具有默认值。 让我们定义一个名为“ Page”的注释，它定义应用程序的UI页面： public @interface Page { ...
Java 注释
java_nx的博客
05-01 583
Java 中注释分为三种 单行注释 多行注释 文本注释 注释不会被执行 写代码写注释是一个非常好的习惯。 单行注释 // 多行注释 /**/ 文本注释/***/
【Java】代码注释标准解析
Code Metaverse
11-30 1610
一、写在前面 注释对于一个项目来说非常重要，好的注释可以让同项目的同学快速熟悉每个模块的作用。 二、代码注释 + JavaDoc 1.类注释 /** * 我是类注释 * @author 作者 * @since 2021-02-22 22:22 * @version 1.1.1 */ 2.方法注释 /** * 方法注释和类注释一样两个冒号开头 * <p> * 描述 * <p/> * * @param pa
阿里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."); } ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值