精华内容
下载资源
问答
  • Java注释
    千次阅读
    2021-02-28 16:01:29

    注释(commentary )是程序中用于说明和解释的一段文字对程序运行不起作用。程序 中添加注释的目的是增强程序的可读性。

    Java提供3种注释方式:。

    单行注释://

    多行注释/**/

    文档注释:

    /**

    *文档注释用于从源代码自动生成文档执行javadoc

    *命名根据源代码中的内容生成网页

    *@XXX

    */

    不同格式的注释可以嵌套。

    // Welcome1.java. Text-printing program.

    /*计信学院09软件工程2班

    **姓名XXX

    **2011年2月26日1800最后修改。*/

    public class Welcome1

    {

    // main method begins execution of application

    public static void main( String args[] ){

    System.out.println( "梅花香子苦寒来!" );

    }

    }

    文档注释参数说明

    @see 生成文档中的“参见xx 的条目”的超链接后边可以加上“类名”、“完整类名”、“完整类名#方法”。可用于类、方法、变量注释。@param 参数的说明。可用于方法注释。@return 返回值的说明。可用于方法注释。@exception 可能抛出异常的说明。可用于方法注释。@version 版本信息。可用于类注释。@author 作者名。可用于类注释。

    >javadoc first.java

    javadoc命令javadoc [options] [packagenames] [sourcefiles]

    -public 仅显示 public 类和成员 -protected 显示 protected/public 类和成员 (缺省)-package 显示 package/protected/public 类和成员-private 显示所有类和成员-d 输出文件的目标目录-version 包含 @version 段-author 包含 @author 段-splitindex 将索引分为每个字母对应一个文件-windowtitle 文档的浏览器窗口标题

    Eclipse中JavaDoc的生成方式

    在项目列表中选择项目按右键选择Export导出然后在Export(导出)对话框中选择java下的javadoc。

    在Javadoc Generation对话框中有两个地方要注意的 1javadoc command:应该选择jdk的bin/javadoc.exe。 2destination:为生成文档的保存路径。

    更多相关内容
  • 超级好用的 java 注释模板,吐血总结,整理。吐血总结,整理。
  • 满足IntelliJ、eclipse、As等编辑器的Java开发注释模板,可以方便的管理自己的代码,包括类注释、方法注释、接口注释
  • java注释模板

    2019-02-21 12:11:00
    实用的的java注释模板,可以让你们的开发注释得到统一。
  • Java注释模板

    2018-06-12 14:38:59
    很多同行都有在这个毛病,开发注释写的不够好,以后看代码的时候给自己造成了很大的困扰,这个Java注释模板就很好地解决了这个问题
  • java 注释模板

    2018-05-28 15:04:42
    java 注释模板 java 注释模板 java 注释模板 java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板
  • Java注释

    2018-10-28 12:10:28
    Java注释的良好习惯,方便项目的交接和事后的维护与整理,是一个很好的帮助自己养成编码习惯的工具,效果图在我的博文有记录,有需要的伙伴可以自行下载哦~
  • JAVA注释方法及格式

    千次阅读 2021-02-28 08:51:33
    JAVA注释方法及格式1、单行(single-line)--短注释://……单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。注释格式:/* 注释内容...

    2019独角兽企业重金招聘Python工程师标准>>>

    JAVA注释方法及格式

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

    单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。注释格式:/* 注释内容 */行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。注释格式:// 注释内容行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。注释格式:代码 + 8(至少4)个空格 + // 注释内容

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

    注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成:/*  * 注释内容  */

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

    注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符/**......*/之中,注释文档将用来生成HTML格式的代码报告,所以注释文档必须书写在类、域、构造函数、方法,以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下: /*** The doGet method of the servlet. * This method is called when a form has its tag value method * equals to get.* @param request*  the request send by the client to the server* @param response*  the response send by the server to the client* @throws ServletException*  if an error occurred* @throws IOException*  if an error occurred*/

    public void doGet (HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {    doPost(request, response);}

    前两行为描述,描述完毕后,由@符号起头为块标记注释。更多有关文档注释和javadoc的详细资料,参见javadoc的主页: http://java.sun.com/javadoc/index.html

    4、javadoc注释标签语法

    @author    对类的说明 标明开发该类模块的作者 @version   对类的说明 标明该类模块的版本 @see      对类、属性、方法的说明 参考转向,也就是相关主题 @param    对方法的说明 对方法中某参数的说明 @return    对方法的说明 对方法返回值的说明 @exception  对方法的说明 对方法可能抛出的异常进行说明

    JAVA注释具体实现

    1、源文件注释

    源文件注释采用 /** …… */,在每个源文件的头部要有必要的注释信息,包括:文件名;文件编号;版本号;作者;创建时间;文件描述包括本文件历史修改记录等。中文注释模版:/*** 文 件 名 : * CopyRright (c) 2008-xxxx:* 文件编号:* 创 建 人:* 日    期:* 修 改 人:* 日   期:* 描   述:* 版 本 号:*/

    2、类(模块)注释:

    类(模块)注释采用 /** ……*/,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模块)历史修改记录等。英文注释模版:/*** CopyRright (c)2008-xxxx:                             * Project:                                                               * Module ID:       * Comments:                                             * JDK version used:                                    * Namespace:                                         * Author:                         * Create Date:  * Modified By:                                            * Modified Date:                                      * Why & What is modified      * Version:                                         */如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释://Rewriter //Rewrite Date: Start1: /* 原代码内容*///End1: 将原代码内容注释掉,然后添加新代码使用以下注释://Added by //Add date: Start2: //End2:如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下注释://Log ID://Depiction://Writer:修改者中文名//Rewrite Date:

    2.1 接口注释:

    接口注释采用 /** …… */,在满足类注释的基础之上,接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用,块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。

    3、构造函数注释:

    构造函数注释采用 /** …… */,描述部分注明构造函数的作用,不一定有块标记部分。注释模版一:/*** 默认构造函数*/注释模版二:/*** Description :       带参数构造函数,*                       初始化模式名,名称和数据源类型* @param schema:   模式名* @param name:   名称* @param type: 数据源类型*/

    4、函数注释:

    函数注释采用 /** ……*/,在每个函数或者过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等。函数注释里面可以不出现版本号(@version)。注释模版一:/**  * 函 数 名 :  * 功能描述:* 输入参数:     *             ** 返 回 值:  - 类型 *            * 异    常:* 创 建 人: * 日    期:* 修 改 人:* 日    期:*/注释模版二:/*** FunName:           getFirstSpell  * Description :      获取汉字拼音首字母的字符串,*                   被生成百家姓函数调用  * @param:         str the String是包含汉字的字符串  * @return String:汉字返回拼音首字母字符串;*                  英文字母返回对应的大写字母;*                 其他非简体汉字返回 '0';* @Author:       ghc* @Create Date: 2008-07-02*/

    5、方法注释:

    方法注释采用 /** …… */,对于设置 (Set 方法 ) 与获取 (Get 方法 )成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索。

    6、方法内部注释:

    控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释。

    7、全局变量注释:

    要有较详细的注释,包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。

    8、局部(中间)变量注释:

    主要变量必须有注释,无特别意义的情况下可以不加注释。

    9、实参/参数注释:

    参数含义、及其它任何约束或前提条件。

    10、字段/属性注释: 字段描述,属性说明。

    11、常量:常量通常具有一定的实际意义,要定义相应说明。

    转载于:https://my.oschina.net/u/2260184/blog/591582

    展开全文
  • java 注释模版 codetemplates.xml
  • java注释统计工具

    2015-11-02 16:53:44
    自己做得java项目注释统计工具,可统计代码行数,注释行数,能统计各种注释样式,能看统计详细情况,能生成报表,可自由控制合格率!算法高效!
  • 代码要是没有注释,对读者来说就是一堆乱七八糟的字母,为了提高代码的可读性和可维护性,必须对代码进行必要的注释,这里小编整理了一下java注释规范。(一)技巧1:注释当前行快捷方式:ctrl+/2:/* */ 选上要注释的...

    代码要是没有注释,对读者来说就是一堆乱七八糟的字母,为了提高代码的可读性和可维护性,必须对代码进行必要的注释,这里小编整理了一下java注释规范。

    (一)技巧

    1:注释当前行快捷方式:ctrl+/

    2:/* */  选上要注释的代码 ctrl+Shift+/

    (二)在哪些地方加注释?

    1:每个源文件开头都应有一组注释,包含代码的作者,时间;

    2:当编写的代码较长,并且包含了多层嵌套时,花括号会比较多,比较乱,为了方便阅读,应该在某些段落结束的地方加注释,注明该闭合花括号对应的起点;

    3:每个方法都必须加注释,对方法等进行注释时,注释最好放在代码上方,对变量声明进行注释时,注释最好放在行尾,但多行的行尾注释应该对齐;

    4:典型算法必须有注释,代码有bug或不清楚的地方必须加注释,修改过的代码要加修改标志的注释。

    (三)注释遵循哪些原则?

    1:利用缩进和空行将注释与代码分隔开,是代码与注释在没有颜色提示情况下也能很容易分辨出来;

    2:将注释内容与注释分隔符用一个空格隔开,便于查找注释;

    3:对多行注释是尽量不用使用/*  * /,而是用多行“//”,可以避免查找配对的/*  */

    (四)注释方法分类

    1:单行注释-----//

    单独行注释:

    当注释需要单独单用一行时,使用“//” 并在注释前留一个空行,缩进情况要与下面的代码一致。一行放不下时使用多行,此时使用/*  */进行注释。

    行尾注释:

    在代码行的行尾加注释,一般要空8个格,且所有注释必须对齐。

    2:块注释---/*内容*/

    对若干行进行注释,一般放在方法之前,起引导作用,对方法和数据结构等的功能,意义进行说明

    /*

    *注释内容

    */

    3:文档注释

    注释若干行,将会形成HTML格式的代码报告,注释文档必须写在类,成员变量,成员方法,构造方法之前,例如下面是一个servlet创建后生成的一个注释文档

    /**

    * The doGet method of the servlet.

    *

    * This method is called when a form has its tag value method equals to get.

    *

    * @param request the request send by the client to the server

    * @param response the response send by the server to the client

    * @throws ServletException if an error occurred

    * @throws IOException if an error occurred

    */

    public void doGet(HttpServletRequest request, HttpServletResponse response)

    throws ServletException, IOException {

    doPost();

    }

    4:类注释

    在myEclipse中,可以通过快捷键Alt+Shift+J生成,注释的内容可以通过Eclipse -> Window -> Preferences -> Java -> Code Style -> Code Templates -> Comments ->      Types -> Edt 设置

    格式如下:

    /**

    * @author ASWH

    *

    * @Time 2014-3-30-17:33:01 */

    类的英文注释模板

    /**

    * CopyRright (c)2014-xxxx:

    * Project:

    * Module ID:

    * Comments:

    * JDK version used:

    * Namespace:

    * Author:

    * Create Date:

    * Modified By:

    * Modified Date:

    * Why & What is modified

    * Version:

    */

    中文模板

    /**

    * 文 件 名 :

    * CopyRright (c) 2014-xxxx:

    * 文件编号:

    * 创 建 人:

    * 日 期:

    * 修 改 人:

    * 日 期:

    * 描 述:

    * 版 本 号:

    */

    7:构造函数注释

    /**

    * 构造方法 的描述

    * @param name

    *

    */

    8:方法注释

    /**

    * 生成随机数

    *@param numble

    随机数上限

    *@return

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

    * @author ASWH

    * @Time2014-3-30 17:35:29

    */

    9:全局变量注释

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

    private int count;

    有必要是要说明变量功能,涉及到的方法等等。

    10:普通变量或常量

    //属性

    附录:javadoc参数说明:

    @see 生成文档中的“参见xx 的条目”的超链接,后边可以加上:“类名”、“完整类名”、“完整类名#方法”。可用于:类、方法、变量注释。

    @param 参数的说明。可用于:方法注释。

    @return 返回值的说明。可用于:方法注释。

    @exception 可能抛出异常的说明。可用于:方法注释。

    @version 版本信息。可用于:类注释。

    @author 作者名。可用于:类注释。

    @deprecated 对类或方法的说明 该类或方法不建议使用,引起不推荐使用的警告

    @note  表示注解,暴露给源码阅读者的文档

    @remark 表示评论,暴露给客户程序员的文档

    @since 表示从那个版本起开始有了这个函数

    @see  表示交叉参考

    版权声明:本文为博主原创文章,未经博主允许不得转载。

    展开全文
  • Java 注释

    万次阅读 2019-01-22 14:49:37
     程序注释的作用非常大,很多初学者在刚刚学习java程序的时候,会很努力的写程序,不太会注意添加注释。认为添加注释是一种浪费时间,没有意义的事情。经过一段时间的学习,注意到程序书写的不足,需要重构。于是...

    (一)注释的重要性

        编写程序的时候,总需要为程序添加一些注释,用以说明某段代码的作用,或者说明某个类的用途,某个方法的工能,以及该方法的的参数和返回值的数据类型以及意义等

        程序注释的作用非常大,很多初学者在刚刚学习java程序的时候,会很努力的写程序,不太会注意添加注释。认为添加注释是一种浪费时间,没有意义的事情。经过一段时间的学习,注意到程序书写的不足,需要重构。于是打开源码,以为可以很轻松的改写原有代码,但这个时候会发现理解原来写的代码会非常的困难,很难理解原有的编程思路。

    为什么需要添加注释,至少有如下三方面的考虑:

    1 永远不要过于相信自己的理解能力:

    2 可读性第一,效率第二!

    3 代码即文档:

          程序注释是源代码的一个重要部分,对于一份规范的程序源代码而言,注释应该占到源代码的三分之一以上。几乎所有的编程都提供了注释的方法,一般包括,单行注释,多行注释。java语言也不例外,不仅包括单行注释,多行注释,还提供了一种文档注释。java语言的注释一共有三种类型。

     

    (二)java的三种注释

    单行注释:在程序中注释一行代码

    多行注释:一次性的将程序中多行代码注释掉。

    文档注释:注释允许你在程序中嵌入关于程序的信息。

    (三)单行注释,多行注释

    单行注释:将双斜线//放到需要注释的内容之前就可以了。

    多行注释:使用/*  和 */ 将程序中需要注释的内容包含起来。

    /* 表示注释的开始    */ 表示注释的结束。

     

     

    (四)增强文档注释

        java还提供了一种功能更强大的注释形式,文档注释。它以 /** 开始,以 */结束。例子如下:

    /*** 
    * 这是一个注释
    * @author alan
    * @version 1.2
    */

        如果编写java源代码的过程中添加了文档注释吗,然后通过JDK提供的javac工具可以直接将源代码里的文档注释提取程一份系统的API文档。

    javadoc 工具软件识别以下标签:

    标签描述示例
    @author标识一个类的作者@author description
    @deprecated指名一个过期的类或成员@deprecated description
    {@docRoot}指明当前文档根目录的路径Directory Path
    @exception标志一个类抛出的异常@exception exception-name explanation
    {@inheritDoc}从直接父类继承的注释Inherits a comment from the immediate surperclass.
    {@link}插入一个到另一个主题的链接{@link name text}
    {@linkplain}插入一个到另一个主题的链接,但是该链接显示纯文本字体Inserts an in-line link to another topic.
    @param说明一个方法的参数@param parameter-name explanation
    @return说明返回值类型@return explanation
    @see指定一个到另一个主题的链接@see anchor
    @serial说明一个序列化属性@serial description
    @serialData说明通过writeObject( ) 和 writeExternal( )方法写的数据@serialData description
    @serialField说明一个ObjectStreamField组件@serialField name type description
    @since标记当引入一个特定的变化时@since release
    @throws和 @exception标签一样.The @throws tag has the same meaning as the @exception tag.
    {@value}显示常量的值,该常量必须是static属性。Displays the value of a constant, which must be a static field.
    @version指定类的版本@version info

     

     

        javadoc 输出什么?

    javadoc 工具将你 Java 程序的源代码作为输入,输出一些包含你程序注释的HTML文件。

    每一个类的信息将在独自的HTML文件里。javadoc 也可以输出继承的树形结构和索引。

    由于 javadoc 的实现不同,工作也可能不同,你需要检查你的 Java 开发系统的版本等细节,选择合适的 Javadoc 版本。

     

    参考:http://www.runoob.com/java/java-documentation.html

    展开全文
  • Java代码注释规范详解

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

    2020-08-19 13:04:06
    java 注释符号 1. 单行注释// public class Hello { public static void main(String[] args) { // 向屏幕输出文本 System.out.println("Hello, world!"); } } 2.多行注释/*... */ public class Hello { ...
  • JAVA注释模板

    2015-05-17 11:43:53
    JAVA注释模板, 开发中Eclipse工具中配置的
  • java注释规范文档

    2011-09-07 13:26:28
    java程序注释的规范,每个初学者都应该掌握规范进行编程开发和学习,习惯了规范,自然就会提升代码的质量,提升团队的开发进度!
  • 【摘要】注释是对程序语言的说明,有助于开发者和用户之间的交流,我希望大家一定要了解Java注释类型有哪些?这几种注释竟然能为我们带来这些,今天小编就带大家看看Java注释类型有哪些?这几种注释竟然能为我们带来...
  • 本篇文章主要介绍了IDEA添加Java注释模版的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
  • Java注释规范

    2014-07-11 15:53:34
    定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失
  • java注释的三种形式

    千次阅读 2021-03-18 09:42:47
    JAVA注释共有三种形式:单行注释、多行注释、文档注释1.单行注释public class online{public static void main(String[] args) {//这是一个单行注释System.out.println("Hello World!");}}2.多行注释public class ...
  • idea修改Java注释的颜色

    千次阅读 2021-01-29 23:54:51
    刚上手idea,见识了许多强大之处,第一次知道这个工具还是在2018年的暑假,当时也安装体验了,那个时候刚接触Java差不多有半年多的时间了,eclipse都没玩熟就没在具体了解过了。idea唯一不好的是更新有点麻烦,没有...
  • Java代码注释模板

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

    千次阅读 多人点赞 2020-04-18 10:40:35
    注释是对java源代码的解释说明。 注释可以帮程序员更好的理解程序。 2、注释信息只保存在java源文件当中,java源文件编译生成的字节码class文件, 这个class文件中是没有这些注释信息的。 3、在实际的开发中,...
  • 很棒的Java注释处理 Java注释处理(由定义)是用于连接到Java编译器的标准化API,允许您验证正在编译的代码并生成其他(源或字节)代码。 该旨在概述有关该API的有用资源,包括现有的有用注释处理器,相关演示文稿和...
  • Eclipse Java注释模板.txt

    2019-07-09 09:16:44
    JAVA注释模板以及详细设置解释等等。 注释模板 如何设置
  • Java注释跳转

    千次阅读 2019-12-09 13:46:14
    文章目录 在注释中进行跳转,可以看一下系统源码 知道的两个@,一个是@see,一个是@Link 可以参考下:博文
  • 编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。 下载该文件后选择右侧Import导入该文件就创建模板成功了. 可以点击每一个选项根据...
  • Java注释 及 标识符

    千次阅读 2019-09-06 20:21:55
    Java注释主要分为单行注释、多行注释和文档注释: 单行注释: 使用“//”开头,“//”后面的单行内容均为注释。 多行注释: 以 “/*” 开头以 “*/” 结尾,在 “/*” 和 “*/” 之间的内容为注释,我们...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 725,030
精华内容 290,012
关键字:

java注释

java 订阅
友情链接: KEISOKU GIKEN 6605.zip