精华内容
下载资源
问答
  • java代码注释

    2018-02-18 10:35:50
    定义:java代码注释就是备注功能:为了提高代码的可读性分类:单行注释、多行注释、文档注释单行注释:就是指只注释一段代码比如:int number;//定义一个整型变量多行注释:一次性注释多行代码比如:/*int i = 10;...

    定义:java代码的注释就是备注

    功能:为了提高代码的可读性

    分类:单行注释、多行注释、文档注释

    单行注释:就是指只注释一段代码

    比如:int number;//定义一个整型变量


    多行注释:一次性注释多行代码

    比如:/*
    int i = 10;
    double money = 12.9;
    */


    文档注释:文档注释可以被javadoc工具读取出来并形成程序文档的注释格式。

    比如:/**
    注释内容
    */

    总结:代码的注释,简单来说分为三类,单行注释,多行注释,文档注释;他们的功能都是为了提高代码的可读性;当然有时候也可以用户代码的排查。


    展开全文
  • Java代码注释

    2017-05-23 10:29:00
    通过代码注释,可提高程序的可读性。注释中包含了程序的信息,可以帮助从程序员更好的阅读和理解程序。Java源文件的任意位置都可以添加注释语句。注释的文字Java编译器不进行编译,所有代码中的注释文字对程序不产生...

      通过代码注释,可提高程序的可读性。注释中包含了程序的信息,可以帮助从程序员更好的阅读和理解程序。Java源文件的任意位置都可以添加注释语句。注释的文字Java编译器不进行编译,所有代码中的注释文字对程序不产生影响。Java提供了三种注释方法,分别为单行注释,多行注释,文档注释。

     

      1 单行注释

      “//”为单行注释的符号,从符号“//”开始到换行位置均为注释而被Java编译器忽略。语法如下:

          //注释内容

      例如:以下代码为声明int型变量添加注释。

      int age;    //定义int型变量用于保存年龄信息

     

      2 多行注释

      “/**/”为多行注释标记,符号“/*”与“*/”之间的所有内容都为注释内容。注释中的内容可以】换行。

      语法如下:

      /*

      注释内容1

      注释内容2 

      */

     

      注意

      多行注释中可以嵌套单行,例如:

      /*

      程序名称:hello Word //开发时间为2017年

      */

     

      但是在多行注释中不能嵌套多行注释,例如:

      /*

        程序名称:hello Word

        /*

        开发时间:2017年

        作者:CHEN

        */

      */

      此程序为错误的。

     

      3 文档注释

      “/***/”为文档注释的符号,符号“/**”与符号“*/”之间额内容为注释内容。当文档注释出现在声明变量(如类的声、明类成员变量的声明、类成员方法的声明等)之前时,会被Javadoc文档工读取为Javadoc文档内容。文档注释的格式与多行注释的格式相同,对于初学者而言,文档注释并不是很重要,了解即可。

      

      说明

      一定要养成良好的编程风格,软件编程规范中提到“可读性第一,,效率第二”,所以程序员一定要在编程中添加适量的注释来提高代码的可读性和可维护性。程序中注释要占程序代码总量的20%~50%。

    转载于:https://www.cnblogs.com/bigswallow/p/6892896.html

    展开全文
  • 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代码注释模板配置文件,直接导入Eclipse就可使用
  • java 代码注释详讲

    2020-03-04 17:01:34
    Java 代码注释 1. 代码注释的目的 在代码中添加注释能提高代码的 可读性,注释中包含了程序的信息,可以帮助程序员更好的阅读程序。 学会代码注释是做好程序员的第一步。 2. java 代码注释的方法(三种) 单行注释...

    Java 代码注释详讲

    1. 代码注释的目的

    在代码中添加注释能提高代码的 可读性,注释中包含了程序的信息,可以帮助程序员更好的阅读程序。 学会代码注释是做好程序员的第一步。

    2. java 代码注释的方法(三种)

    1. 单行注释
      注释标记 :// 从符号 // 开始直到换行位置的所有内容均作为注释而被编译器忽略
      语法如下

      // 注释内容
      

      java 单行注释

    2. 多行注释

    多行注释的标记 :/**/ 符号之间 /* 与 */ 所有内容均为只是内容。 注释中可以换行
    语法如下:

    ```javascrip
    /* 
    	注释内容1
    	注释内容2	
    	....
    		*/
    ```
    ![java 多行注释](https://img-blog.csdnimg.cn/20200304164421785.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NDE5NDE4,size_16,color_000000,t_70)
    

    3. 文档注释

    文档注释的标记:/** ... */  符号 /*** 与 */  之间的内容均为文档注释的内容. 
    文档注释出现的地方:==类声明 类的成员变量声明 类的方法声明 等==
    语法如下
    ```javascript
    /**
    	文档注释1
    	文档注释3
    	...	
    		*/
    ```
    ![java 文档注释](https://img-blog.csdnimg.cn/2020030416591341.png)
    
    展开全文
  • JAVA代码注释规范codetemplates.xml,可直接导入Eclipse,代码注释效果很棒!
  • Java代码注释率检查器
  • java代码注释规范引(阿里巴巴开发规范-注释规约)结合注释规约,在IDEA下设置相应的注释模板1,安装阿里巴巴开发规约的IDEA提示插件,这样能够在很大程度上规范自己的编程规范,在出现代码编写风格不规范的情况下会...
  • JAVA代码注释规范

    千次阅读 2018-05-29 21:36:56
    JAVA代码注释规范一、 规范存在的意义1. 好的注释规范可以让人一眼看明白这是干什么的,特别是对于我们这种行业;共同合作完成一个项目需要分工明确,所以也需要有明了的注释规范。2. 正确的应用注释规范可以增加...
  • java代码注释规范

    2016-04-09 23:24:48
    java代码注释规范 代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 23,484
精华内容 9,393
关键字:

java代码注释

java 订阅