JAVA代码注释规范

最新推荐文章于 2024-07-22 02:08:54 发布
最新推荐文章于 2024-07-22 02:08:54 发布
阅读量491 收藏
点赞数

转载地址

 

整个类文件注释 
示例如下: 
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
关注
Java开发: 代码、注释规范
qq_40600408的博客
03-16 345
本文档编写的目的就是通过建立编码规范，使每个开发人员养成良好的编码风格和习惯；并以此形成开发团队编码约定，提高程序的可靠性，可读性，可修改性，可维护性和一致性等，增进团队间的交流，并保证在程序质量。 1.介绍 编码规范对于程序员而言尤为重要，有以下几个原因： 一个软件的生命周期中，80%的花费在于维护； 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护； 编码规范可以改善软...
Idea-Java代码注释规范
bozi
11-16 7941
  IDEA自带的注释模板不是太好用，我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家（如果嫌配置繁琐，可以在本页面最下方下载jar包，导入idea，就可以了）。 一、首先我们来设置IDEA中类的模板：（IDEA中在创建类时会自动给添加注释） 1、File &gt; settings &gt; Editor &gt; File and Code Template...
java代码注释规范文档
09-18
后端开发技术的代码注释规范 单行注释 多行注释 块注释 文档注释 标签注释等等
java代码注释规范
热门推荐
shiyuezhong的专栏
11-20 19万+
代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在诉求网二期开发中使用的代码注释规范，供大家参考下。 原则： 1、注释形式统一 在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的
规范：java代码编写规范
最新发布
为无为，事无事，味无味。
07-22 1285
比如在项目中不同的类型的业务可能需要上传各种各样的附件，此时就可以定义好不同的一个附件的枚举，来区分不同业务的附件。不要在代码中直接写死，不定义枚举，代码阅读起来非常困难，直接看到数字都是懵逼的。。我们做了这么多的工作，最终也只有跑起来才能够看到效果，所以在maven打包的时候，不要在了，让测试跑起来。如果可以的话，把单元测试加到我们的CI/CD流程中，只有常态化的用起来，才可以真正的产生效果。上面这些只是我在进行代码质量实践时的一些经验，并不适用于所有人或者场景，但是不管我们可以做到多少，怎么做，
Java 注释
weixin_30550081的博客
11-18 323
Java 注释 标签 : Java基础 五月份得知入职阿里云OS, 才开始学Java, 断断续续学习/使用半年, 越来越喜欢这个语言/工具. 后来被拥抱变化之后, 拿到的大部分offer是Java服务端研发; 一路走来, 踩了很多坑, 也有了一点小小的心得, 而且博客已经停更几个月, 今天就以博客形式把他记录下来吧. 2015下半年第一篇博客, 从最基础的...
java注释规范_Java代码注释规范详解
weixin_34377697的博客
02-12 2295
代码附有注释对程序开发者来说非常重要，随着技术的发展，在项目开发过程中，必须要求程序员写好代码注释，这样有利于代码后续的编写和使用。基本的要求：1、注释形式统一在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。2、注释内容准确简洁内容要简单、明了、含义准确，防止注释的多义性，错误...
Java代码注释规范(动力节点整理)
08-30
Java代码注释规范是编程实践中不可或缺的一部分，它有助于提高代码的可读性和团队协作效率。以下是一些关于Java代码注释的基本原则和建议： 1. **注释形式统一**： - 在整个代码库中，应保持注释风格的一致性。这...
Java代码注释规范.docx
05-09
【Java代码注释规范】 Java代码注释规范是软件开发中的一个重要组成部分，它不仅有助于提升代码的可读性和可维护性，还能增强团队间的协作效率。遵循良好的编码规范，可以帮助开发者形成良好的编程习惯，培养更加...
Java代码注释规范详解
09-02
Java代码注释是编程实践中不可或缺的一部分，它有助于提高代码的可读性和维护性。下面将详细阐述Java代码注释的一些规范和最佳实践。 1. **注释形式统一**： - 保持一致性是关键。在同一个项目中，注释应该采用...
java注释模版（java-code style-codetemplate）
02-24
java注释模版,使程序运行更让人容易看懂，和理解，加快速度
JAVA代码注释规范codetemplates.xml
01-26
JAVA代码注释规范codetemplates.xml，可直接导入Eclipse,代码注释效果很棒！
Java开发手册之注释规约
m0_75232472的博客
04-15 614
在开头跟大家分享的时候我就说，面试我是没有做好准备的，全靠平时的积累，确实有点临时抱佛脚了，以至于我自己还是挺懊恼的。（准备好了或许可以拿个40k，没做准备只有30k+，你们懂那种感觉吗）如何准备面试？1、前期铺垫（技术沉积）程序员面试其实是对于技术的一次摸底考试，你的技术牛逼，那你就是大爷。大厂对于技术的要求主要体现在：基础，原理，深入研究源码，广度，实战五个方面，也只有将原理理论结合实战才能把技术点吃透。
java 注释 代码_java注释代码规范
weixin_34369657的博客
02-12 112
//收集了一小部分，忘记的时候过来查一下java--hadoop部分/*** 此类用来处理DNS原始日志：统计给定域名平均响应时延*@paramInput*@paramOutput*@paramcacheUriListfilePath*@paramcacheIpNetTypefilePath* [文件cachefile需要上传HDFS,文件为K-V形式,多个V用;隔开]** NOTE:该类适合限定...
java if 规范_Java if else分支结构精讲
weixin_39603588的博客
03-04 586
Java 支持两种选择语句：if 语句和 switch 语句。其中 if 语句使用布尔表达式或布尔值作为分支条件来进行分支控制，而 switch 语句则用于对多个整型值进行匹配，从而实现分支控制。这些语句允许你只有在程序运行时才能知道其状态的情况下，控制程序的执行过程。如果你没有 C/C++ 的编程背景，你将会为这两个语句的强大功能和灵活性而感到吃惊。选择结构(也叫分支结构)解决了顺序结构不能判断...
java注释详解_Java文档注释详解
weixin_29053383的博客
02-12 775
一.javadoc1.简述对于Java语言，最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程序的文档化问题。对于程序的文档化，最大的问题 莫过于对文档的维护。若文档与代码分离，那么每次改变代码后都要改变文档，这无疑会变成相当麻烦的一件事情。解决的方法看起来似乎很简单：将代码同文档 “链接”起来。为达到这个目的，最简单的方法是将所有内容都置于同一个文件。然而，为使一切都整...
Java注释规范
u010490755的博客
12-15 262
代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在诉求网二期开发中使用的代码注释规范，供大家参考下。 原则： 1、注释形式统一 在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值