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

    千次阅读 2008-11-24 17:25:00
    java中的注释分为实现注释和文档注释,实现注释就是那些/*……..*/和//……的注释,是注释程序用的,文档注释是/**…….*/的注释,是用来生成javadoc的。eclipse(以下简称ec)中的注释规范在Window->Preference->Java...
        java中的注释分为实现注释和文档注释,实现注释就是那些/*……..*/和//……的注释,是注释程序用的,文档注释是/**…….*/的注释,是用来生成javadoc的。eclipse(以下简称ec)中的注释规范在Window->Preference->Java -> Code Style -> Code Template中设置
    •     文件注释(files)
        文件头注释以 /*开始,以*/结束,其中列出类名,版本信息,日期和版权声明。
    在ec的code Template中选择comments下的Files,点击Edit进行编辑,比如做成下面这样

        /*
         * ${file_name}
         * Version 1.0.0
         * Created on ${date}
         * Copyright your company
         *
         */

        设置好了之后,你新建类的时候ec就会自动帮你生成文件注释了。
    以下类型的注释在ec中设置跟这个一样,下面就不详细说明了,注释类型后的括号里表示的是在ec上要设置的类型
    •      类、接口注释(types)
        类、接口注释/**开始,以*/结束,作为类或接口的介绍信息出现在生成的javadoc中。一般写成下面这样。

        /**
         * This class SortedTable is used to create a sorted Jtable
         * @author jnight
         * @see java.swing.JTable
         */

        例子中出现的@author和@see是标记。标签分为块标签(block tag)和内联标签(inline tag)。块标签直接@tag来用,内联标签是{@tag}来用的。下面介绍几个常用的块标签
    1. @author
    用在类注释中,表示作者。函数注释里面可以不出现@author。

    2. @version
    用在类注释中,表示版本信息。函数注释里面可以不出现@version。

    3 @since
    用在类注释中,标明该类可以运行的JDK版本

    4.@param标记
    @param标记后跟的是方法的参数名,注意不是参数类型。

    5.@return标记
    @return后跟的是方法的返回值类型。返回为空(void)的构造函数或者函数,@return
    可以省略。

    关于注释标签的详细信息可以看http://java.sun.com/j2se/javadoc/writingdoccomments/#tag
    •     属性注释(field)
        可以是实现注释也可以是文档注释,如果是文档注释,会在javadoc中出现,比如

    /** the comments of the String field.*/
        private String strField = "";
    •     方法注释
        方法注释采用 /** … */,描述部分注明方法的功能,块标记部分注明方法的参数,返回值,异常等信息。例如:

        /**
         * comments of your meyhod.
         * @param str comments of the String parameter.
         * @return int
         *
         */

    关于java的注释规范可以详见http://java.sun.com/j2se/javadoc/writingdoccomments/
    展开全文
  • 但是,有很多人并不清楚,为什么要写注释怎么写注释。导致有很多人,开发的时候,并没有写注释,或者写的注释存在着各种各样的问题第一,我们为什么要写注释?回想一下,当我们刚开始学习java的时候,是不是会经常...

    学习过java的同学,应该都知道java中存在着三种注释,单行注释、多行注释、文本注释。但是,有很多人并不清楚,为什么要写注释,怎么写注释。导致有很多人,开发的时候,并没有写注释,或者写的注释存在着各种各样的问题

    第一,我们为什么要写注释?

    7dbd18da8d0fba3ca2fe95df9536b543.png

    回想一下,当我们刚开始学习java的时候,是不是会经常翻阅java api手册。这个手册,其实就是通过javadoc工具,根据java源代码中的文档注释自动生成的。所以写好JAVA文档,是可以帮助我们自动生成api文档的。这个api文档,不管是对内部使用或者对外提供,都是非常有用的。

    80872f8bebca0eecb7a7bb422cae91ad.png

    在想一下,当我们接手一个新项目的时候。你不仅是需要查看相应的api文档,你还需要深入了解一下每个方法内部的逻辑,具体实现。这时候,如果没有注释。可能你就要花费大量的时间,去思考代码实现或者找原作者沟通了。但有时,就算你花费了大量时间,可能还是不懂或者连原作者自己也看不懂当时自己写的代码了。所以,注释是一个很好的东西,他可以帮我们理解程序中的每一行代码在做什么,以及为什么这么做。

    e17c5102c91823900fbc85c284ac0652.png

    注释当然还有很多其它的作用。但就是以上两点,已经足够让我们认真写好我们项目当中的注释了。

    第二,我们应该怎么写好注释?

    我觉得每一个项目团队,或者程序员个人,都应该有自己的一套完整注释模板。这个在idea或者eclipse等项目管理工具中,都有提供模板功能的。我们可以通过这个模板功能,来管理自己的注释。

    8bc4f9b267201acf64a536f69da14e8b.png

    一般我们需要准备以下几种模板。

    1、文件注释模板。

    文件注释写在文件的最上方,用于介绍该文件的信息。一般包含文件作者、文件创建时间、文件描述、文件版本号等信息

    2、接口或类注释模板

    接口或类注释,放在接口或类的声明上,用于介绍该类或者接口的信息。一般包含作者、创建时间、文件描述等信息。该注释与文件注释有些类似

    3、方法注释模板

    方法注释,放在方法上面,用于介绍方法的信息。一般包含方法的入参、反参、抛出异常、作者、创建时间,方法描述等信息

    有了模板之后,我们可以通过模板,在类、接口、方法上,更加方便地添加我们的注释了。

    另外,我们比较常用的,还有属性注释,方法内部的注释

    属性注释。属性注释写在java对象的属性声明上,用于描述对象属性的含义。

    方法内的注释。方法内部注释,写在方法内部,用于描述接下来一行或者一段代码的业务逻辑或者执行步骤。

    在我们写java注释的时候,还有有一个非常重要的概念,就是doc标签。这些标签是由java官方提供的。用于描述类、方法等的基本属性,标签以@开始。一般常用的标签有@author、@date、@since、@param、@throw、@return等。

    5ec48ac506865e7fb09ead5704f44788.png

    在编写注释模板,或者我们手动书写注释的时候,应该尽量按照javadoc规范来。

    好的代码注释,能使我们代码的维护成本大大降低。减少一些不必要的沟通成本,也在另一方面提升了我们的开发效率

    坏的注释,有时会让你觉得莫名其妙。代码的可读性和维护性,大大降低。

    而且随着时间的推移,注释会对项目的影响会越来越大。所以,我们应当在项目的开始阶段,就有意识地完善我们的代码注释了。

    java中的注释,要讲的内容还是有很多的。如果大家有什么不清楚的,想了解的,都欢迎在下面评论区留言。我会一一回复的

    展开全文
  • Java注释怎么写

    2020-05-23 21:24:07
    Java注释讲解 注释 注释是给程序员看的,程序并不会去执行它,也不会报错 单行注释 //双斜杠后面的就是被注释掉的内容(注释这一行) 多行注释 /*这中间包括的都是注释,可以同时注释多行*/ /* 我是注释 我是...

    Java注释讲解

    注释

    • 注释是给程序员看的,程序并不会去执行它,也不会报错

    单行注释

    //双斜杠后面的就是被注释掉的内容(注释这一行)
    

    多行注释

    /*这中间包括的都是注释,可以同时注释多行*/
    /*
    	我是注释
    	我是注释
    	我也是注释
    */
    

    JavaDoc文档注释

    /**
    *这中间的就是文档注释
    *写在类前面就是类的信息
    *写在方法前面就是方法的信息
    *
    */
    eg:
    /**
    *@author 作者
    *@version 版本号
    *@since 指明需要最早使用的jdk版本
    *@param 参数名
    *@return 返回值情况
    *@throws 异常抛出情况
    */
    

    展开全文
  • 注释一直是Java的一个非常重要的部分,并且从J2SE 5.0开始就已经存在。我们所有人都 在某个地方或其他地方在我们的应用程序代码中看到了@Override 和这样的注释 @Deprecated。在本文中,我将讨论注释的确切含义,...

    注释一直是Java的一个非常重要的部分,并且从J2SE 5.0开始就已经存在。我们所有人都 在某个地方或其他地方在我们的应用程序代码中看到了@Override 和这样的注释 @Deprecated。在本文中,我将讨论注释的确切含义,引入的原因,它们的工作方式,如何编写自定义注释(带有示例代码),可能有效的注释方案,最后是注释和ADF。这将是一篇很长的文章,所以请喝点咖啡,准备好进入注释世界。

    什么是注释?

    解释注释的一个词是元数据。元数据是关于数据的数据。因此,注释是代码的元数据。例如,看下面的代码。

    @Override

    public String toString() {

    return "This is String Representation of current object.";

    }

    我已经覆盖了 上面的代码中的 toString() 方法并使用了 @Override注释。即使我不放 @Override,代码也可以正常工作而没有任何问题。那么,此注释的优点是什么? @Override 告诉编译器此方法是重写的方法(有关该方法的元数据),并且如果父类中不存在任何这样的方法,则抛出编译器错误(方法不会从其超类中重写方法)。现在,如果我犯了一个印刷错误,并且将方法名称用作 toStrring() {double r},并且如果我不使用 @Override,则我的代码将成功编译并执行,但是结果将与我接受的结果不同。所以现在,我们了解了什么是批注,但是阅读正式定义还是不错的

    注释是一种特殊的Java构造,用于装饰类,方法,字段,参数,变量,构造函数或包。它是JSR-175选择提供元数据的工具。

    为什么要引入注释?

    在注释之前(甚至之后),XML被广泛用于元数据,并且以某种方式,一组特定的应用程序开发人员和架构师认为XML维护变得越来越麻烦。他们想要的东西可以与代码而不是XML紧密结合,而XML与代码之间的联系非常松散(在某些情况下,几乎是分开的)。如果您搜索“ XML与注释”,您会发现很多有趣的争论。有趣的一点是,引入了XML配置以将配置与代码分开。最后两个语句可能会在您的脑海中产生一些疑问,因为这两个语句正在创建一个周期,但是两者各有利弊。让我们尝试通过一个例子来理解。

    假设您要设置一些应用程序范围的常量/参数。在这种情况下,XML是一个更好的选择,因为它与任何特定的代码段都不相关。如果要将某个方法作为服务公开,则注释将是一个更好的选择,因为它需要与该方法紧密结合,并且方法的开发人员必须意识到这一点。

    另一个重要因素是,注释定义了在代码中定义元数据的标准方法。在注释之前,人们还使用自己的方式定义元数据。一些示例使用标记界面,注释,临时关键字等。每个开发人员都需要用自己的方式来决定元数据,但要注释标准化的东西。

    如今,大多数框架都将XML和注解结合使用,以充分利用两者的积极方面。

    批注的工作方式以及如何编写自定义批注

    在开始解释之前,建议您下载此注释示例代码(AnnotationsSample.zip)并在您选择的任何IDE中保持打开状态,因为这将帮助您更好地理解以下说明。

    编写注释非常简单。您可以将注释定义与接口定义进行比较。让我们看两个示例-一个是标准 @Override 注释,另一个是自定义注释@Todo:

    @Target(ElementType.METHOD)

    @Retention(RetentionPolicy.SOURCE)

    public @interface Override {

    }

    似乎有些可疑@Override; 它没有做任何事情-它只是检查看是否在父类中定义了一个方法。好吧,不要惊讶。我不是在开玩笑。覆盖注释的定义仅包含那么多代码。这是最重要的部分,我要重申一下:注释只是元数据,不包含任何业务逻辑。很难消化,但确实如此。如果注释不包含逻辑,则其他人必须在做某事,并且某人是此注释元数据的使用者。注释仅提供有关在其上定义属性的信息(类/方法/包/字段)。使用者是一段代码,它读取此信息,然后执行必要的逻辑。

    当我们谈论诸如之类的标准注释时 @Override, JVM是使用者,它在字节码级别工作。现在,这是应用程序开发人员无法控制并且不能用于自定义注释的功能。因此,我们需要自己给消费者写注释。

    让我们一一理解用于注释的关键术语。在以上示例中,您将看到在批注中使用了批注。

    J2SE 5.0在java.lang.annotation包中提供了四个注释,这些注释仅在编写注释时使用:

    @Documented –是否在Javadocs中添加注释

    @Retention –需要注释时

    @Target? –放置注释的位置

    @Inherited –子类是否获得注释。

    @Documented –一个简单的市场注释,告诉您是否要在Java文档中添加注释。

    @Retention –定义注释应保留多长时间。

    RetentionPolicy.SOURCE –编译期间丢弃。这些注释在编译完成后没有任何意义,因此不会写入字节码。范例: @Override, @SuppressWarnings

    RetentionPolicy.CLASS –在上课时丢弃。在进行字节码级后处理时很有用。令人惊讶的是,这是默认设置。

    RetentionPolicy.RUNTIME –不要丢弃。注释应可在运行时用于反射。这就是我们通常用于自定义注释的内容。

    @Target –可以放置注释的位置。如果未指定,则注释可以放置在任何地方。以下是有效值。这里的一个重要点是它仅包含所有内容,这意味着如果要对7个属性进行批注,而只想排除一个属性,则在定义目标时需要包括所有7个属性。

    ElementType.TYPE(类,接口,枚举)

    ElementType.FIELD(实例变量)

    ElementType.METHOD

    ElementType.PARAMETER

    ElementType.CONSTRUCTOR

    ElementType.LOCAL_VARIABLE

    ElementType.ANNOTATION_TYPE(在另一个注释上)

    ElementType.PACKAGE(记住package-info.java)

    @Inherited –控制注释是否应影响子类。

    现在,注释定义里面有什么?注释仅支持原语,字符串和枚举。注释的所有属性都定义为方法,还可以提供默认值

    @Target(ElementType.METHOD)

    @Retention(RetentionPolicy.RUNTIME)

    @interface Todo {

    public enum Priority {LOW, MEDIUM, HIGH}

    public enum Status {STARTED, NOT_STARTED}

    String author() default "Yash";

    Priority priority() default Priority.LOW;

    Status status() default Status.NOT_STARTED;

    }

    以下是如何使用上述注释的示例:

    @Todo(priority = Todo.Priority.MEDIUM, author = "Yashwant", status = Todo.Status.STARTED)

    public void incompleteMethod1() {

    //Some business logic is written

    //But it’s not complete yet

    }

    如果注释中只有一个属性,则应将其命名为“值”,并且在使用它时可以不使用属性名称。

    @interface Author{

    String value();

    }

    @Author("Yashwant")

    public void someMethod() {

    }

    到目前为止,一切都很好。我们已经定义了定制注释,并将其应用于某些业务逻辑方法。现在,该写一个消费者了。为此,我们将需要使用反射。如果您熟悉反射代码,则知道反射提供了类,方法和字段对象。所有这些都有一个 getAnnotation() 方法,该方法返回注释对象。我们需要将此对象强制转换为自定义注释(使用进行检查后instanceOf()),然后才能调用自定义注释中定义的方法。让我们看一下使用上面的注释的示例代码:

    Class businessLogicClass = BusinessLogic.class;

    for(Method method : businessLogicClass.getMethods()) {

    Todo todoAnnotation = (Todo)method.getAnnotation(Todo.class);

    if(todoAnnotation != null) {

    System.out.println(" Method Name : " + method.getName());

    System.out.println(" Author : " + todoAnnotation.author());

    System.out.println(" Priority : " + todoAnnotation.priority());

    System.out.println(" Status : " + todoAnnotation.status());

    }

    }

    注释用例

    注释功能非常强大,Spring和Hibernate之类的框架将注释广泛用于日志记录和验证。注释可以在使用标记接口的地方使用。标记接口用于完整的类,但是您可以定义可以在单个方法上使用的注释,例如,某个方法是否作为服务方法公开。

    在Servlet规范3.0中,引入了许多注释,尤其是与Servlet安全性相关的注释。让我们看看一些:

    HandlesTypes –此注释用于声明传递给的应用程序类的数组 ServletContainerInitializer。

    HttpConstraint -该注释表示被施加到与HTTP协议方法类型的所有请求未否则通过相应的表示的安全约束 HttpMethodConstraint 的 ServletSecurity 注释。

    HttpMethodConstraint –特定的安全约束可以应用于不同类型的请求,通过在注释内部使用此注释,可以根据HTTP协议方法类型进行区分 ServletSecurity 。

    MultipartConfig –该注释用于指示声明了它的Servlet希望使用multipart / form-data MIME类型进行请求。

    ServletSecurity –在Servlet实现类上声明此注释,以对HTTP协议请求强制实施安全性约束。

    WebFilter –用于声明Servlet过滤器的注释。

    WebInitParam –用于在WebFilter 或 WebServlet 注释内的Servlet或过滤器上声明初始化参数的 注释。

    WebListener — 在给定的Web应用程序上下文中用于声明各种事件的侦听器的注释。

    WebServlet –此注释用于声明Servlet的配置。

    ADF(应用程序开发框架)和注释

    现在,我们处于讨论的最后部分:应用程序开发框架,也称为ADF。ADF由Oracle开发,用于构建Oracle Fusion Applications。我们已经看到了优点和缺点,并且知道如何编写自定义注释,但是在ADF中可以在哪里使用自定义注释呢?ADF是否提供任何本机注释?

    这些肯定是有趣的问题:但是,是否存在某些限制会阻止在ADF中大规模使用注释?前面提到的框架(如Spring和Hibernate)使用AOP(面向方面​​的编程)。在AOP中,该框架提供了一种机制,可以为任何事件注入用于预处理和后处理的代码。例如,您具有在方法执行前后放置代码的钩子,因此可以在这些位置编写使用者代码。ADF不使用AOP。如果我们有任何有效的注释用例,则可能需要通过继承方法。

    最后,开发这么多年我也总结了一套学习Java的资料与面试题,如果你在技术上面想提升自己的话,可以关注我,私信发送领取资料或者在评论区留下自己的联系方式,有时间记得帮我点下转发让跟多的人看到哦。

    展开全文
  • 文档注释概览“文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而注释,它是一种带有特殊功能的注释。文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。比如:/*** 这是文档注释...
  • 几行代码也许很容易知道功能,但几百行的代码,多个文件,也许刚的时候是知道功能与特性的,但是随着时间的流逝,对自己的代码越来越难以理解,更别说其他人了。代码的可读性巨差,影响编程开发效率。注释的分类1 ...
  • 经过对本文的阅读与学习,以后再创建 .java 或 .jsp 文件时,eclipse 就会为我们自动将注释写好。你还可以通过“导出”、“导入”功能,把自己的模板导出来,方便在其他机器上使用。在使用Eclipse 编写Java代码时,...
  • 优秀的java程序员怎么写注释

    千次阅读 2018-08-12 11:22:41
    今天我们来说说如何编写Java注释。使用过Java的同学都非常熟悉,Java中有: §单行注释// 这是单注释 §多行注释/*这是多行注释*/ §Javadoc注释/**这是javadoc注释*/ 其实这里面还有很多细节呢,下面我们一一来...
  • 怎么写Java注释

    2015-01-23 22:14:36
    Our audience is advanced (not novice) programmers, so it is generally not necessary to link to API in the java.lang package (such as String), or other API you feel would be well-known. Omit ...
  • java注释

    2021-04-06 21:23:19
    关于java程序当中的注释: *什么是注释?注释的作用是什么?...*java中的注释怎么写? - 单行注释 //单行注释,只注释当前行 - 多行注释 /*多行注释 多行注释 多行注释 ...... */ - javac...
  • 文件注释创建文件后, 编译器会在类名前面生成固定的注释, 来丰富代码的可读性, 在阿里巴巴Java开发手册里也明确到所有的类都必须添加创建者和创建日期.image/*** description: ${NAME} * date: ${DATE} ${TIME} * ...
  • Java注释

    2021-03-20 15:42:07
    Java注释 //单行注释 /*多行注释/ 文档注释(java特有) 格式: /** @author 指定java程序的作者 @version 指定源文件的版本 */ 文档注释方法 例: 1.首先在代码里上注释 2.使用命令 javadoc -d myHello -version ...
  • 样例:/** * @author 雷钊 ... */可以选择每次复制这一段代码到java 文件头中 也可以直接配置: Header File Android Studio中,进入File Header的步骤 File->Settings->Editor->File and Code Template
  • 我不知道这个,但是java中不是有java生成注释文档的吗?你怎么不去研究一下这个呢?引用对于Java语言,最体贴的一项设计就是它并没有打算让人们为了程序而程序——人们也需要考虑程序的文档化问题。对于程序的文档...
  • Java注释详解

    2020-10-30 19:26:28
    注释有利于帮助我们读懂代码,有时候写了一些复杂的代码,可能过几天就忘记了是怎么写的,这时候就需要注释帮助我们想起来。也可以用注释注释掉我们不想运行的代码。 注释在代码中是不会被执行的,在集成开发环境中...
  • 一份Java文档注释

    2019-02-23 19:47:49
    Java文档注释注释的形式编写,注释里可以上这个代码起到了什么,怎么调用。与此同时, Java为大家提供了把文档注释转换为网页文档的工具,这使别人无需打开这个类文件就能从网站上看到这个类的使用说明书,帮助...
  • 为什么要写说明书 我写好了一个JAVA程序卖给你,从源码可以...怎么写一个java程序说明 java的说明书通常使用文档注释来完成 /** 第一行通常是描述信息:例子:这是一个数组工具类该类提供了排序,最值等功能。 @auth...
  • 如果是出现在外显子上的突变,想了解这些突变会对编码蛋白造成怎么样的影响,这些统统能用annovar解决,选择annovar的Gene-based annotation即可,可查看之前的笔记Annovar注释vcf-笔记但是如果想获得其他信息或者说...
  • # 背景某天,在我的代码里了如下这么一行注释,让我吃惊是注释里面的代码被执行了。按常规思路,这行代码被注释了,控制台应该不会有执行结果,但是却出现了如下返回结果。到这里,我们能大概猜测是 Unicode 解码...
  • 在本文中,Java ME专家Kay Glahn分析了Oracle关于Java ME,SE和Java FX的计划,并解释了为什么他认为Oracle的路线图不仅会对开发社区乃至整个行业都产生积极影响。 在他的演讲中,Thomas Kurian预测了应用程序...
  • 1.关于java源程序中的注释: 什么是注释?注释的作用是什么? 只会出现在java源程序当中,作为java源程序的解释说明(程序...2.java中的注释怎么写? -单行注释://单行注释,只注释当前行 -多行注释:/* ...
  • java代码怎么写用命令行调用keytool生成证书,最好具体一点,有注释最好
  • 区分大小2,只认分号,不认换行3,所有分隔符号都是英文标点4,所有的java程序由public static void main(String[] args)方法开始执行二,java注释// #单行注释/* */ #多行注释/** */ #文档注释,用来生成文档三,...
  • 1、注释如果程序中代码太多时,方便我们查看代码,所以就要给代码写注释,便于其他人读取,注释里面的内容是不会显示出来,也不会对程序有影响的。Java中提供了三种注释方式,分别是:①单行注释 //注释内容② 多行...
  • 这个是我的程序。但似乎有很多问题。我想计算总线条、空白线条、注释线条和代码行。但我不能运行这个程序。我知道我计算评论行的方法是错了。真的吗需要帮助。在def FileLineCount(filename):(shotname,extension)...
  • java中的System.out.format("c1=0x"+"x%",c1)的注释怎么写java中的format用法有哪些啊,什么情况下可以用?
  • 对于Java语言,最抚恤的一项设计即便它并未曾计划让人们为了过程而过程——人们也必需琢磨过程的文档化问题。对于过程的文档化,最大的问题莫过度对文档的维护。若文档与代码离别,那么每次改换代码后都要改换...
  • JAVA语言的注释

    2019-06-23 20:29:40
    注释出现在JAVA源程序中,...java注释怎么写? - 单行注释 // 只注释当前行 - 多行注释 /* 多行注释 多行注释 多行注释 多行注释 */ - javadoc注释 * * * */ 很专业的注释,会被javadoc.exe提取并生成帮助文档。 ...
  • 环境变量后,我们就可以开始写程序了,那么程序怎么写呢,用什么工具呢,我建议为了方便学习,我们最好在一个磁盘下建立一个专门的文件来写java程序,比如就在D盘下建立一个名为“java”的目录,然后在这个目录下写...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 432
精华内容 172
关键字:

java注释怎么写

java 订阅