精华内容
下载资源
问答
  • Java注释

    万次阅读 多人点赞 2019-09-28 22:23:28
    定义 用于解释说明程序的文字 分类 单行注释 格式: // 注释文字 ...注释内容在程序编译的时候会被忽视,不会产生目标代码,注释的部分不会对程序的执行结果产生任何影响。 注意事项 多行和文档注释都不能...

    定义

    • 用于解释说明程序的文字

    分类

    • 单行注释
      格式: // 注释文字
    • 多行注释
      格式: /* 注释文字 */
    • 文档注释
      格式:/** 注释文字 */

    作用

    • 在程序中,尤其是复杂的程序中,适当地加入注释可以增加程序的可读性,有利于程序的修改、调试和交流。注释的内容在程序编译的时候会被忽视,不会产生目标代码,注释的部分不会对程序的执行结果产生任何影响。

    注意事项

    • 多行和文档注释都不能嵌套使用。
    展开全文
  • java类注释模板

    万次阅读 2018-05-10 10:56:37
    英文模板: /** * * Simple to Introduction * @ProjectName: [${project_name}] * @Package: [${package_name}.${file_name}] * @ClassName: [${type_name}] * @Description: [句话描述该的功能] *...

    英文模板:

     

    /**   
     *  
     * Simple to Introduction  
     * @ProjectName:  [${project_name}] 
     * @Package:      [${package_name}.${file_name}]  
     * @ClassName:    [${type_name}]   
     * @Description:  [一句话描述该类的功能]   
     * @Author:       [${user}]   
     * @CreateDate:   [${date} ${time}]   
     * @UpdateUser:   [${user}]   
     * @UpdateDate:   [${date} ${time}]   
     * @UpdateRemark: [说明本次修改内容]  
     * @Version:      [v1.0] 
     *    
     */

     

    中文模板:


     /**   
      * 
      * Simple To Introduction
      * 项目名称:  [${project_name}]
      * 包:        [${package_name}]    
      * 类名称:    [${type_name}]  
      * 类描述:    [一句话描述该类的功能]
      * 创建人:    [${user}]   
      * 创建时间:  [${date} ${time}]   
      * 修改人:    [${user}]   
      * 修改时间:  [${date} ${time}]   
      * 修改备注:  [说明本次修改内容]  
      * 版本:      [v1.0]   
      *    
      */

    展开全文
  • 、设置类注释模板 1.选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header. 注释模板: /** * @Title: ${file_name} * @Package ${...

    一、设置类注释模板

    1.选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header. 

    注释模板:

    /**  
     * @Title:  ${file_name}   
     * @Package ${package_name}   
     * @Description: ${todo}
     * @author: runoob     
     * @date:   ${date} ${time}   
     * @version V1.0 
     */

    二、设置方法注释模板

    Idea没有可以直接设置方法注释模板的地方,可以借用Live Templates基本实现,步骤如下。 
    1.选择File–>Settings–>Editor–>Live Templates,先选择右侧加号新建一个自己的模板组,如图 我这里命名模板组名为myGroup。

     

    2.选中组,选择右侧加号新建模板

    3、方法注释模板:

    /**   
     * @Title: $enclosing_method$  
     * @Description: $todo$
     * @param: $param$    
     * @return: $return$ 
     * @date: $date$ $time$    
     * @throws   
     */

    4.点击Define,勾选Java 

    5.点击Edit variables编辑变量,设置如下,点击Ok–>Apply完成设置。

    6.输入“/**”,然后按Tab键即可生成注释。live这种方式是需要在方法内部生成,否则@param等一些参数会是null。不像eclipse 方法头部就可以。 有知道改进的同学还望评论告知一声。

    展开全文
  • 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

    展开全文
  • IDEA添加Java类注释模版

    万次阅读 2017-11-29 19:24:06
    IDEA版本:IntelliJ IDEA 2017.2.5 x64eclipse能在上方输入/**,回车添加类注释模版,但idea没有默认添加这功能,需要做一些设置。下面介绍三种方法,实现创建默认添加类注释、手动添加类注释、批量添加JavaDoc...
  • java注释

    千次阅读 2019-05-12 21:54:00
    Java注释java中注释有三种:这些都称之为java doc标记,含义如下: java中注释有三种: 单行注释 //注释的内容, 多行注释 /…注释的内容…/, 文档注释 /**…注释的内容….*/。 就是为了便于javadoc程序自动生成...
  • eclipse新建Java类注释模板

    千次阅读 2009-11-04 09:24:00
    window-reference-java-code style-code templates-comments,选中type,然后点击【edit】按钮,输入类注释信息,保存。以后要添加版权时,按Ctrl+alt+J,就可以了。/** * @ ${file_name} * 作用 * 注意事项 * ...
  • intellij自动生成java代码注释,包括java文件头部的注释java方法的注释
  • JAVA类注释

    千次阅读 2012-07-31 10:48:35
    为了更好的描述 JAVA中的每一个类的作用,我们给所创建的每个加上注释,让人能一目了然的看到该是做什么的。 我用的是 MyEclipse ,要给它加类注释,选择 window下的 Preferences 中左边的 java下的 code Style ...
  • java注释分为3种 单行注释 // 注释内容 多行注释 /* 注释内容 */ 文档注释 /** 注释内容 */
  • java类注释的认识

    千次阅读 2013-11-06 07:47:22
    提到java中的注释可能但凡有点java知识的人会认为,这狗屁博客太没水平了,谁不知道啊,java中的注释分为:单行注释和多行注释。想来您可能也就知道这么多,关于注释的其他方面的知识你知道吗,请参见本博文,本博文...
  • Java文档注释 /**文档注释内容*/,注意区分多行注释/*多行注释*/。 Eclipse怎么生成API帮助文档呢, 方法有三: 方法:选择工程,在菜单Project->Genarate Javadoc  方法二:选择工程,鼠标右键菜单Export ...
  • java注释方法

    千次阅读 2019-05-19 18:41:15
    Java注释的好处:java注释可以帮助我们去理解代码,Javac不会去编译注释,Java运行也不会管我们的注释内容,合理运用注释可以让我们的代码更容易让编程人员理解。 Java的注释有以下几种: 1.单行注释:// 单行注释...
  • Java基础系列4-Java注释

    千次阅读 2021-08-09 10:04:51
    文章目录一. 注释分类二.注释规范参考: 一. 注释分类 网上有个段子: 一段代码如果不写注释,三个月以内,只有写代码的人能看懂,三个月以后,估计只有上帝能看懂。 虽然是个段子,但是也从侧面说明了写...下面是一个
  • 获取java类中的属性注释

    千次阅读 2020-07-08 14:21:22
    一般我们的某个数据库表对象model,java bean对象如下: package com.xxx.message.model; import com.middol.common.model.BaseModel; import lombok.Data; import lombok.EqualsAndHashCode; import javax....
  • java文档注释

    千次阅读 2018-04-02 21:37:53
    Java 支持三种注释方式。前两种分别是 // 和 /* */,第三种被称作说明注释,它以 /** 开始,以 */结束。 这里主要讲述,最后种方法注释,因为可以使用 javadoc 工具软件来生成信息,并输出到HTML文件中。 注释...
  • IntelliJ IDEA中Java类和方法注释

    千次阅读 2018-03-21 09:43:18
    类注释: File-->Settings-->Editor-->File and CodeTemplates 模板/** * @Description: * @Author: YangYong * @Date: $DATE ${TIME} */ 方法注释: 1. File-->Settings-->...
  • Java注释规范整理

    千次阅读 2014-07-19 15:20:56
    但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个Java注释规范》,内容来自网络、书籍和自己的...
  • Java文档注释

    千次阅读 2018-07-26 12:37:05
    Java中已经自带文档注释工具: JDK——>bin——&...建立一个用于操作数组的工具,其中包含着常见的对数组操作的函数如:最值,排序等 。 @author 张三 @version V1.0 */ public class...
  • Eclipse Java注释模板

    千次下载 热门讨论 2015-08-06 17:47:10
    Eclipse Java注释模板。 注释: /** * @ClassName * @Description * @author * @Date * @version */ 属性注释: /** * @Field @param */ 函数注释: /** * @Description * @param p1 * @param ...
  • Idea设置java类方法注释模板

    千次阅读 2019-06-24 17:13:22
    1,类注释:File-->Settings-->Editor-->File and CodeTemplates 模板: /** * @description: * @author: ${USER} * @date: ${DATE} ${TIME} */ 2,方法注释:File-->Settings-->Editor-...
  • Java-文档注释

    万次阅读 多人点赞 2018-08-21 00:15:02
    1 Java注释概述 Java的三种注释: (1)单行注释:// 注释内容 (2)多行注释:/… 注释内容…./ (3)文档注释:/*.. 注释内容…./ (这种注释可以用来自动地生成文档。在JDK中有javadoc的工具,可以...
  • 1. IDEA 自动生成 对于中的注释,我们可以通过IDEA自动生成。...File Header来设置模板,这样新建文件时,IDEA会按照设置的模板,会自动生成一个注释。 其中标签有: ${USER} : 当前用户。 ...
  • 写代码的时候,有时候,你需要写一些注释...不管他具体有什么功能,咱就只管一个,他可以链接代码,让注释看的更清楚易懂。方便你我他。 @see 标签允许用户引用其他的文档。具体使用方式如下: @see classname @see
  • Java 注释技巧

    千次阅读 2014-07-09 21:09:42
    在最初学习Android时候使用了Eclips IDE工具,编写java程序时,总是要添加一些注释,用以说明某段代码的作用,由于是从C过度来的,也没有太在意java注释有何不同,将鼠标移动到Android sdk 提供的、方法、属性上...
  • Java代码注释规范

    千次阅读 2019-03-23 15:29:51
    也是程序代码可维护性的重要环节之。所以我们不是为写注释而写注释。下面说一下我们在日常开发中使用的代码注释规范,供大家参考下。 注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 641,612
精华内容 256,644
关键字:

一个简单的java类的注释内容

java 订阅