精华内容
下载资源
问答
  • Java代码注释规范详解

    2020-09-02 19:50:01
    代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员好代码注释,这样有利于代码后续的编写和使用。下面给大家分享java代码注释的规范,需要的朋友参考下
  • java代码注释模板

    2015-08-23 10:19:10
    java代码注释模板+格式化工具,完全好用,使用。
  • intellij自动生成java代码注释,包括java文件头部的注释,java方法的注释

    1定义java文件头部的注释

    2给java类中的方法添加上注释

          2.1第一步勾选Enable Live  Templates

          2.2第二步新建一个Group

          2.3第三步新建一个Template

          2.4第四步点击Define按钮

          2.5第五步填写注释模板

     

    1、定义java文件头部的注释

    打开设置面板,然后填写注释模板:

    File  => setting  => editor =>  File and Code Templates

    如图:

     

    2、给java类中的方法添加上注释

    2.1、第一步勾选Enable  Live  Templates

    首先要在上一章节的图中勾选中 Enable  Live  Templates

    如图:

    2.2、第二步新建一个Group

    其次要打开LiveTemplates 然后新建一个Group

    如图:

         

     

    在弹窗口中输入你想要的group名称,例如我取名叫chenjieGroup

    如图:


    点击OK,你已经新建了一个模板组,名称叫chenjieGroup

    如图:

     

     

    2.3、第三步新建一个Template

           选中新建的group,也就是选中chenjieGroup,在这个group下新建一个LiveTemplate

    如图:

     

           上图中点击Live Template之后,将会新建一个模板,并且光标定位到了需要你输入快捷键的方框中

     如图:


            我输入了cjm意思是当我在java文件的某个方法内部,连续输入cjm后,intellij将会在该方法的头上为我自动生成注释(根据我接下来定义的模板来生成)。

     

    2.4、第四步点击Define按钮

             点击上图中的Ok按钮左上方的define

      如图:

     

     

           在弹出的下拉框内选择作用域,这里选择java文件

       如图:

      

     

    2.5、第五步填写注释模板

     在第四步完成后,Templatetext框内的内容可以编辑了,在Template text 内写入模板,例如我敲入的模板是:

    /**

     *@描述 

     *@参数  $params$

     *@返回值  $return$

     *@创建人  chenjie

     *@创建时间  $date$

     *@修改人和其它信息

     */

    如图:


         说明:在此步骤中,模板内容你可以自己写,两个$号内部是参数名称,都有哪些参数呢,你可以点击Editvariables,然后在弹窗口中自己查看和选择

       点击Edit variables会弹出框

    如图:

       

     

    弹出框

    如图:

       

     

       上图中,Name这一列是你可以设置的参数名称,Expression这一列是你可以选择的表达式,点击Expression这一列的单元格,即可出现下拉框

       如图:

      

     

    例如我依次给params、return、date这三个变量设置了表达式

    如图:


    点击OK(两个窗口上的OK都要点击)

     

    好了,现在可以验证了。

    新建一个Utils类

    如图:

      

    取名Utils

    如图:

      

    可以看到,文件头部的注释已经有了

    如图:

       

    新建一个方法,内容如下:

     public static String sayHello(String userName)
    {
         return "hello "+userName; 
    }

     

    如图:

      

    在上图画红框的地方输入我们刚才设置的快捷键cmj即可看到intellij给我们添加的注释

    如图:

       

     

    快捷键需要在方法内部,也就是花括号内部,至于是不是在红框的位置都可以,例如在return语句的后面或者其他地方也可以,只要是在sayHello方法内部即可。我输入cjm然后就可以得到提示

    如图:

     

    好了,敲回车后,intellij将我输入的cjm替换为了方法的注释(根据我们上一步设置的模板来生成注释)

     如图:


           说明:此时有点2,还需要自己把注释剪切到方法外部去,不过总比我们手动敲注释好多了。快捷键可以在方法外部敲,也可以生成注释,但是参数和返回值就没法给你生成了,因为参数和返回的值只有在函数作用域内,intellij才能找到,所以快捷键最好还是在方法内部敲,我刚才的cjm就是在方法内部敲的。

    展开全文
  • Java代码注释

    千次阅读 2015-05-27 17:21:38
    而对于别人写代码不加注释的“坏习惯”,我深表遗憾。然而当我读完Robert的“注释”一节,我已经懊恼不已,并且我已经开始对我的代码进行审核,再次优化。我已经开始遵守“别给糟糕的代码注释–重新吧”这条准则...

    曾经我对“一份好的代码里注释至少要占到一半的份量”这样话深信不疑,我也不厌其烦的给每一个函数都加上javadoc,对此,我深感自豪;而对于别人写代码不加注释的“坏习惯”,我深表遗憾。然而当我读完Robert的“注释”一节,我已经懊恼不已,并且我已经开始对我的代码进行审核,再次优化。我已经开始遵守“别给糟糕的代码加注释–重新写吧”这条准则。

    也许你是一个好人,会对代码进行不断的优化改进,然而你经常会把注释忽略掉,就如同下面这样:

    /**
      * 集合竞价.
      *
      * @param orderFromClient
      * @return
      */
     private Message callAuction(SelfOrder orderFromClient, long b, JadeInfo jadeInfo) {

    方法参数已经改变了,然而javadoc的注释中依然只有一个参数。

    我个人已经深深地被Robert影响了,代码才能最忠诚的告诉它在做什么,而不是注释。但是我们很多人,包括在看这本书之前的我,认为写得一手好注释的程序员才是好程序员,当然这不包含那些只会写糟糕代码的人。

    用代码来阐述

    我们来比较一下这两种代码:

    public void pause() {
    
      if (isNotAction()) {
       return;
      }
    }
    
    /**
      * 节假日或当天无交易商品,服务器不执行操作
      */
     private boolean isNotAction() {
    if (isHoliday || !hasTradingJade) {
       return true;
      }
    
      return false;
     }
    public void pause() {
    // 节假日或当天无交易商品,服务器不执行操作
    if (isHoliday || !hasTradingJade) {
       return ;
      }
    }

    我认为第一种更好,因为节假日以及无交易商品,就说明服务器当日不需要运行,那么用isNotAction来表明会更好。

    好注释

    对意图进行解释

    /* 
      * 按照用户id对资金变化量进行排序,从而保证在多线程同时更新资金字段时,不发生死锁
      */
     @Override
     public int compareTo(VarialMoneyUser o) {
      return this.getUid().compareTo(o.getUid());
     }

    这样的注释,我认为还不错,说明了使用compare的意图。

    TODO注释
    有的时候,我们的需要做一些事情,而我们暂时没有做,那么就可以使用TODO,这样IDE就会管理到这些TODO,当然还有FIXME标记,表明我们有些问题暂时不知道怎么优化、改善。

    trade.setDjzj(BigDecimal.valueOf(0));// FIXME 冻结资金待实现
    // TODO 计算账户的盈亏,根据风险控制等级,标示次日需要提醒、限制交易、强制平仓的账户

    但是需要注意,定期的回头检查,eclipse提供以下图片的功能,你要删除那些无用的TODO

    这里写图片描述

    坏注释

    喃喃自语

    public void dailyUpdateSystemData() {
      // 每日更新时进行一次会员信息更新
      AllMembercoes.init();

    以上的注释毫无必要。

    多余的注释

    /**
      * @Description: 获取指定日期的行情日报
      */
     public QuotationDailyReport getQuotationReportByDateAndScode(QuotationDailyReport report);
    
     /**
      * @Title: addQuotationReport
      * @Description: 添加行情日报
      * @param tradeReport
      * @return
      */
     public int addQuotationReport(QuotationDailyReport tradeReport);
    
     /**
      * @Title: getLastQuotationReport
      * @Description: 获取指定商品上一次的行情日报信息
      * @param map
      * @return
      */
     @SuppressWarnings("rawtypes")
     public QuotationDailyReport getLastQuotationReport(Map map);

    这些注释比没有注释还可怕,其实看方法名称,都知道要做什么,加上注释后反倒浪费时间。

    ps:我之前非常喜欢加这种注释,我恨不得在每一个方法上面加上注释,但是自从我明白了,方法名本身就应该代表了方法要做什么以后,我深恶痛绝自己以前荒唐的行为

    误导性注释

    这个非常的可怕,很多时候,注释和代码表达的意思完全相反,或者牛头不对马嘴,总之很容易让人迷惑。

    // 12点后设置isreload为true,重新加载配置,
     private void updateReloadStatusTrue() {

    这个注释在本意上应该是非常友好的,提示这个方法是在12点以后执行的,但是我上下文翻看,压根找不到任何12点的信息。

    这样会好一点

    /**
      * 设置isreload为true,表明配置服务、商品服务可以重新加载了
      */
     private void updateReloadStatusTrue() {
      reload = true;
      ConfigService.isReload = reload;
      JadeInfoService.isReload = reload;
     }

    循规蹈矩的注释

    哦,这种注释多发生在方法上,我曾经就非常热衷于这样的注释,现在我才知道其可怕之处。

    /**
      * @Title: updateQuotation
      * @Description: 修改指定商品的行情信息
      * @param quotation
      */
     public void updateQuotation(Quotation quotation) {
      this.quotationMapper.updateQuotation(quotation);
     }

    title、param的注释有两种坏处

    1. 非常多余,难道方法本身不能告诉我吗?
    2. 阻碍重构,当方法名、参数名需要重构或者添加参数时注释是不会紧随变更的。

    这里写图片描述

    日志式注释

    以前我们特别喜欢在代码里加上以下这样注释

    // start update by maweiqing
          // 如果能够接收到消息,说明客户端已经进行操作了,那么就更新session的时间
          data = CryptUtil.encrypt(data, SessionManager.getSession(getSession().getSessionId())
            .getEncryptKey());
    
          // end update by maweiqing 2015-05-27

    看到Robert的建议后,我真的才恍然大悟,这样的代码还要SVN的代码管理器干嘛?SVN在提交的时候自然会让你输入你的修改理由、以及自动显示署名、日期的。

    废话注释

    // 标识列
     private Integer id;
     // 用户id
     private Integer userId;
     // 用户名
     private String userName;

    这样的注释完全没有必要,你认为有吗?

    /**
      * @return the id
      */
     public Integer getId() {
      return id;
     }
    
     /**
      * @param id
      *            the id to set
      */
     public void setId(Integer id) {
      this.id = id;
     }

    还有利用IDE生成的这种bean注释,我真后悔自己当初为什么会这样想,加上这样的注释让自己显得专业吗,显然适得其反。

    位置标记

    虽然我暂时没有在自己的代码中找到,但是之前我这样做过。

    //xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    //aaaaaaaaaaaaaaaaaaaa

    注释掉的代码

    哦,显然我又中招了,之前我特别喜欢把那些所谓还有作用的代码留在代码里,及时压根就是错误的。但是自从我看到Jeff的博客后,我就开始删掉了那些注释掉的代码,今天再看到Robert的文章,感觉这些伟大的程序员他们都会有这样相似的真理。

    如果你的代码中还有这样的注释,请尽快删掉吧,危害太大。

    总结:我觉得Robert的文章越来越深入的影响着我,让我改变了很多陋习。

    展开全文
  • myeclipse java代码注释导入模板 Preferences->Java->Code Style->import就可以; 也可以根据自己的代码注释规范修改这个xml文件
  • Java代码注释规范

    千次阅读 2019-03-23 15:29:51
    代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为注释而注释。下面说一下我们在日常开发中使用的代码注释规范,供...

     

    代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在日常开发中使用的代码注释规范,供大家参考下。

    1. 注释形式统一

    在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范。

     

    1. 注释内容准确简洁

    内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。

    注释条件

    1、基本注释

    (a)    类(接口)的注释

    (b)    构造函数的注释

    (c)     方法的注释

    (d)    全局变量的注释

    (e)    字段/属性的注释

     

     备注:简单的代码做简单注释,注释内容不大于10个字即可,另外,持久化对象或VO对象的gettersetter方法不需加注释。具体的注释格式请参考下面举例。

    2、特殊必加注释

    (a)    典型算法必须有注释。

    (b)    在代码不明晰处必须有注释。

    (c)     在代码修改处加上修改标识的注释。

    (d)    在循环和逻辑分支组成的代码中加注释。

    (e)    为他人提供的接口必须加详细注释。

     

     备注:此类注释格式暂无举例。具体的注释格式自行定义,要求注释内容准确简洁。

    注释格式

    1、单行(single-line)注释:“//……”

    2、块(block)注释:“/*……*/”

    3、文档注释:“/**……*/”

    4、javadoc 注释标签语法

    @author   对类的说明 标明开发该类模块的作者

    @version   对类的说明 标明该类模块的版本

    @see     对类、属性、方法的说明 参考转向,也就是相关主题

    @param    对方法的说明 对方法中某参数的说明

    @return   对方法的说明 对方法返回值的说明

    @exception  对方法的说明 对方法可能抛出的异常进行说明

    参考举例

    1. 类(接口)注释

    例如:

    /**

    * 类的描述

    * @author Administrator

    * @Time 2016-11-14:49:01

    *

    */

    public classTest extends Button {

      ……

    }

     

     

    2.   构造方法注释

    例如:

    public class Test extends Button {

      /**

       * 构造方法 的描述

       * @param name

       *       按钮的上显示的文字

       */

      public Test(String name){

         ……

      }

    }

     

     

    3.   方法注释

    例如

    public class Test extends Button {

      /**

       * 为按钮添加颜色

       *@param color

             按钮的颜色

    *@return

    *@exception  (方法有异常的话加)

    * @author Administrator

    * @Time2012-11-20 15:02:29

       */

      public voidaddColor(String color){

         ……

      }

    }

     

     

    4.   全局变量注释

    例如:

    public final class String

       implements Java.io.Serializable, Comparable<String>,CharSequence

    {

       /** The value is used for characterstorage. */

       private final char value[];

       /** The offset is the first index of thestorage that is used. */

       private final int offset;

       /** The count is the number of charactersin the String. */

       private final int count;

       /** Cache the hash code for the string */

    private int hash; // Default to 0

    ……

    }

     

     

    5.   字段/属性注释

    例如:

    public class EmailBody implements Serializable{

       private String id;

       private String senderName;//发送人姓名

       private String title;//不能超过120个中文字符

       private String content;//邮件正文

       private String attach;//附件,如果有的话

       private String totalCount;//总发送人数

       private String successCount;//成功发送的人数

       private Integer isDelete;//0不删除 1删除

       private Date createTime;//目前不支持定时 所以创建后即刻发送

       privateSet<EmailList> EmailList;

    ……

    }

     

    其实规范是自己订的,只要团队中大家都统一遵守,统一规范,就会取得好的效果,希望对平时不加注释的朋友有点帮助。

     

     

    展开全文
  • JAVA代码注释规范codetemplates.xml,可直接导入Eclipse,代码注释效果很棒!
  • Java代码注释模板

    2017-09-18 16:10:22
    为便于规范各位开发人员代码、提高代码质量,研发中心需要启动代码评审机制。为了加快代码评审的速度,减少不必要的时间,可以加入一些代码评审的静态检查工具,另外需要为研发中心配置统一的编码模板和代码格式化...
  • 很好用的java代码注释模板配置文件,直接导入Eclipse就可使用
  • 清除Java代码注释

    2016-12-26 22:53:27
    1、使用MyEclipse清除注释 2、使用项目工程清除注释 3、简单方便操作 4、代码共享 ..
  • JAVA代码注释规范

    千次阅读 2017-04-25 01:59:27
    JAVA代码注释规范 代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为注释而注释。下面说一下在开发中使用的代码注释...

    注:此文为转载文章,原文地址点这里!!!

    一直纠结注释规范问题,看了一些文档不仅头疼反而更迷糊了,偶然看到下面这篇文章,简单明了豁然开朗,手痒转了过来,文章如下。


    JAVA代码注释规范

    代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下在开发中使用的代码注释规范,供大家参考下。

    原则:

    1、注释形式统一

    在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范。

    2、注释内容准确简洁

    内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。

    注释条件:

    1、基本注释(必须加)

    • 类(接口)的注释

    • 构造函数的注释

    • 方法的注释

    • 全局变量的注释

    • 字段/属性的注释

    备注:简单的代码做简单注释,注释内容不大于10个字即可。另外,PO对象或VO对象的getter、setter方法不需加注释,具体的注释格式请参考下面举例。

    2、特殊必加注释(必须加)

    • 典型算法必须有注释。

    • 在代码不明晰处必须有注释。

    • 在代码修改处加上修改标识注释。

    • 在循环和逻辑分支组成的代码中加注释。

    • 为他人提供的接口必须加详细注释。

    备注:此类注释格式暂无举例,具体的注释格式自行定义,要求注释内容准确简洁。

    注释格式:

    • 单行(single-line)注释:“//……”

    • 块(block)注释:“/……/”

    • 文档注释:“/*……/”

    • javadoc 注释标签语法

      @author 对类的说明 标明开发该类模块的作者

      @version 对类的说明 标明该类模块的版本

      @see 对类、属性、方法的说明 参考转向,也就是相关主题

      @param 对方法的说明 对方法中某参数的说明

      @return 对方法的说明 对方法返回值的说明

      @exception 对方法的说明 对方法可能抛出的异常进行说明

    参考举例:

    1.类(接口)注释

    例如:

       /**
    
        * 类的描述
    
        * @author Administrator
    
        * @Time 2012-11-2014:49:01
    
        */
    
        public classTest extends Button {
    
          ……
    
        }
    

    2.构造方法注释

    例如:

        public class Test extends Button {
    
          /**
    
           * 构造方法 的描述
    
           * @param name
    
           * 按钮的上显示的文字
    
           */
    
          public Test(String name){
    
             ……
    
          }
    
        }
    

    3.方法注释

    例如

        public class Test extends Button {
    
            /**
    
            * 为按钮添加颜色
    
            * @param color
    
            * 按钮的颜色
    
            * @return 
    
            * @exception  (方法有异常的话加)
    
            * @author Administrator
    
            * @Time2012-11-20 15:02:29
    
            */
    
            public voidaddColor(String color){
    
             ……
    
            }
    
        }
    

    4.全局变量注释

    例如:

        public final class String implements Java.io.Serializable, 
    
        Comparable<String>,CharSequence{
    
            /** The value is used for characterstorage. */
    
            private final char value[];
    
            /** The offset is the first index of thestorage that is used. */
    
            private final int offset;
    
            /** The count is the number of charactersin the String. */
    
            private final int count;
    
            /** Cache the hash code for the string */
    
            private int hash; // Default to 0
    
            ……
    
        }
    

    5.字段/属性注释

    例如:

        public class EmailBody implements Serializable{
    
            private String id;
    
            private String senderName;//发送人姓名
    
            private String title;//不能超过120个中文字符
    
            private String content;//邮件正文
    
            private String attach;//附件,如果有的话
    
            private String totalCount;//总发送人数
    
            private String successCount;//成功发送的人数
    
            private Integer isDelete;//0不删除 1删除
    
            private Date createTime;//目前不支持定时 所以创建后即刻发送
    
            privateSet<EmailList> EmailList;
    
            ……
    
        }
    

    结束语

    其实规范是自己订的,只要团队中大家都统一遵守、统一规范,就会取得好的效果,希望对平时不加注释的朋友有帮助。

    展开全文
  • java代码注释规范文档

    2018-09-18 10:33:34
    后端开发技术的代码注释规范 单行注释 多行注释 块注释 文档注释 标签注释等等
  • 对于类中的注释,我们可以通过IDEA自动生成。 如IDEA 可以通过:File->Settings->Editor->File and Code Templates->Includes->File Header来设置模板,这样新建文件时,IDEA会按照设置的模板,会...
  • Java代码注释率检查器
  • java代码注释规范引(阿里巴巴开发规范-注释规约)结合注释规约,在IDEA下设置相应的注释模板1,安装阿里巴巴开发规约的IDEA提示插件,这样能够在很大程度上规范自己的编程规范,在出现代码编写风格不规范的情况下会...
  • 代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。下面通过本文说一下我们在日常开发中使用的代码注释规范
  • java代码注释规范

    万次阅读 多人点赞 2012-11-20 20:20:13
    代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为注释而注释。下面说一下我们在诉求网二期开发中使用的代码注释规范...
  • eclipse中添加Java代码注释模板

    千次阅读 2014-02-28 22:35:58
    eclipse中添加Java代码注释模板 1、Window->Preference->Java->Code Style->Code Template,进入注释编辑界面 2、文件(Files)标签注释 3、类型(Types)标签注释(类的注释) 4、字段(Fields)标签注释 ...
  • JAVA代码注释范例 - 基础知识 - 周老师科研站, JAVA代码注释范例 - 基础知识 - 周老师科研站
  • 超经典的java代码注释格式化模版及配置说明。
  • 解决eclipse中java代码注释变成乱码的问题
  • java代码注释翻译

    千次阅读 2017-11-27 23:55:20
    翻译后注释部分的格式会乱,不过可以手工进行整理。 翻译后的文件直接覆盖了原文件,以防万一请先对原文件夹进行备份。
  • Eclipse Java代码注释模板的设置

    千次阅读 2013-02-27 20:34:12
    Eclipse Java代码注释模板的设置 俗话说,工欲善其事,必先利其器。 eclipse作为一种非常重要的IDE,也是非常重要的。日程工作中,我们可以使用对其进行改造,让它更方便,提高我们工作的效率。Java模板注释...
  • 写代码的时候,有时候,你需要一些注释,把内容相互关联起来,方便自己或别人看的时候,可以直接找到你关联的代码类或者啥的。 这个时候,{@link}与@see,这2个javadoc注解就派上用场了, 不管他具体有什么功能,...
  • IDEA java代码注释格式设置

    千次阅读 2019-06-16 10:50:34
    之前一直用的是Eclipse做开发,经常听别人说IDEA比Eclipse好用,当时觉得有Eclipse就够用,去用IDEA干啥,后来某一次使用IDEA之后,发现再也不想回到...java注释设置 1、点击file->Setting->Editor-&g...
  • 结合阿里规范的JAVA代码注释

    千次阅读 2020-06-20 21:55:44
    网上找的很多的注释模板大部分会引起阿里编码插件的黄色警告,以IDEA为例子,下面提供一套个人总结的不会导致阿里编码插件报警的模板 一、CLASS模板 Setting/Editor/File and Code Templates,选择Class 2.填入...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 483,361
精华内容 193,344
关键字:

java代码的注释怎么写

java 订阅