精华内容
下载资源
问答
  • java注释的作用

    多人点赞 热门讨论 2020-04-18 10:40:35
    注释是对java源代码解释说明。 注释可以帮程序员更好理解程序。 2、注释信息只保存在java源文件当中,java源文件编译生成字节码class文件, 这个class文件中是没有这些注释信息。 3、在实际开发中,...

    1、什么是注释,有什么用?
            注释是对java源代码的解释说明。
            注释可以帮程序员更好的理解程序。

     2、注释信息只保存在java源文件当中,java源文件编译生成的字节码class文件,
            这个class文件中是没有这些注释信息的。

    3、在实际的开发中,一般项目组都要求积极的编写注释。这也是一个java软件工程师的基本素养。

    4、注释不是写的越多越好,精简,主线清晰,每个注释都应该是点睛之笔。(以后慢慢锻炼)

    5. 注释的几种格式:

        // 单行注释

        /*
            多行注释
        */

        /**
        * javadoc注释:这里的注释信息可以自动被javadoc.exe命令解析提取并生成到帮助文档当中。
        */
     

     

    展开全文
  • 注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。类和接口的注释:类和接口必须写注释。该注释放在 package 关键字...

    一般情况下,源程序有效注释量必须在30%以上。注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。

    类和接口的注释:类和接口必须写注释。该注释放在 package 关键字之后,class 或者 interface 关键字之前。

    说明:方便JavaDoc收集。

    示例:

    package com.huawei.msg.relay.comm;

    /**

    * 注释内容

    */

    public class CommManager

    类和接口的注释内容:类的注释主要是一句话功能简述、功能详细描述。

    格式:

    /**

    * 〈一句话功能简述〉

    * 〈功能详细描述〉

    */

    说明:描述部分说明该类或者接口的功能、作用、使用方法和注意事项。

    示例:

    /**

    * LogManager 类集中控制对日志读写的操作。

    * 全部为静态变量和静态方法,对外提供统一接口。分配对应日志类型的读写器,

    * 读取或写入符合条件的日志纪录。

    */

    必须写注释。geter、seter方法不用写注释。写在类属性、公有和保护方法上面。

    示例:

    /**

    * 注释内容

    */

    private String logType;

    /**

    * 注释内容

    */

    public void write()

    成员变量注释内容:成员变量的意义、目的、功能,可能被用到的地方。

    公有和保护方法注释内容:列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。

    格式:

    /**

    * 〈一句话功能简述〉

    * 〈功能详细描述〉

    * @param [参数1] [in或out] [参数1说明]

    * @param [参数2] [in或out] [参数2说明]

    * @return [返回类型说明]

    * @exception/throws [违例类型] [违例说明]

    */

    说明: @exception或throws 列出可能仍出的异常;。

    示例:

    /**

    * 用MD5算法计算输入字符串的32位摘要

    * @param sIn [in] 待处理的字符串

    * @param sOut [out] sIn的32为摘要,调用函数负责new sOut对象

    * @return boolean

    */

    public static boolean getMd5(String sIn, StringBuffer sOut)

    注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

    注释与所描述内容进行同样的缩排。

    说明:可使程序排版整齐,并方便注释的阅读与理解。

    示例:如下例子,排版不整齐,阅读稍感不方便。

    public void example( )

    {

    // 注释

    CodeBlock One

    // 注释

    CodeBlock Two

    }

    应改为如下布局。

    public void example( )

    {

    // 注释

    CodeBlock One

    // 注释

    CodeBlock Two

    }

    将注释与其上面的代码用空行隔开。

    示例:如下例子,显得代码过于紧凑。

    //注释

    program code one

    //注释

    program code two

    应如下书写:

    //注释

    program code one

    (空一格)

    //注释

    program code two

    对变量的定义和分支语句(条件分支、循环语句等)对复杂的分支必须编写注释,如果时间允许,建议对所有分支语句写注释。

    说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。

    对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。

    说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。

    边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

    注释的内容要清楚、明了,含义准确,防止注释二义性。

    说明:错误的注释不但无益反而有害。

    避免在注释中使用缩写,特别是不常用缩写。

    说明:在使用缩写时或之前,应对缩写进行必要的说明。

    用中文写注释,禁止用英文写注释。

    建议

    避免在一行代码或表达式的中间插入注释。

    说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。

    通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。

    说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。

    在代码的功能、意图层次上进行注释,提供有用、额外的信息。

    说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。

    示例:如下注释意义不大。

    // 如果 receiveFlag 为真

    if (receiveFlag)

    而如下的注释则给出了额外有用的信息。

    // 如果从连结收到消息

    if (receiveFlag)

    在程序块的结束行右方加注释标记,以表明某程序块的结束。

    说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。

    示例:参见如下例子。

    if (...)

    {

    program code1

    while (index < MAX_INDEX)

    {

    program code2

    } // end of while (index < MAX_INDEX) // 指明该条while语句结束

    } // end of if (...) // 指明是哪条if语句结束

    方法内的单行注释使用 //。

    说明:调试程序的时候可以方便的使用 /* 。。。*/ 注释掉一长段程序。

    注释使用中文注释和中文标点,不得用英文写注释。方法和类描述的第一句话尽量使用简洁明了的话概括一下功能,然后加以句号。接下来的部分可以详细描述。

    说明:JavaDoc工具收集简介的时候使用选取第一句话。

    顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代码前面进行注释。

    示例:如下是对设置属性的流程注释

    //1、 判断输入参数是否有效。

    ...

    // 2、设置本地变量。

    ...

    一些复杂的代码需要说明。

    示例:这里主要是对闰年算法的说明。

    //1. 如果能被4整除,是闰年;

    //2. 如果能被100整除,不是闰年.;

    //3. 如果能被400整除,是闰年.。

    展开全文
  • 1、注释作用注释可用于解释Java代码,并使其更具可读性。在测试备用代码时,它也可用于阻止执行。单行注释以两个斜杠(//)开头。Java将忽略//与行结尾之间所有文本。本示例在一行代码之前使用单行注释:例如:// ...

    1、注释作用

    注释可用于解释Java代码,并使其更具可读性。在测试备用代码时,它也可用于阻止执行。

    单行注释以两个斜杠(//)开头。

    Java将忽略//与行结尾之间的所有文本。

    本示例在一行代码之前使用单行注释:

    例如:// 注释内容用来解释说明代码

    System.out.println("Hello World");

    本示例在代码行的末尾使用单行注释:

    例如:System.out.println("Hello World"); // 注释内容用来解释说明代码

    2、Java 多行注释

    多行注释以/ *开头,以* /结尾。

    Java将忽略/ *和* /之间的任何文本。

    本示例使用多行注释(注释块)来解释代码:

    例如:/* 注释内容是用来

    * 解释说明代码

    */

    System.out.println("Hello World");

    单行或多行注释

    确定使用哪种注释。 通常,我们使用//进行简短注释,使用/ * * /进行较长注释。public class HelloWorld {

    /* 这是第一个Java程序

    * 它将输出 Hello World

    * 这是一个多行注释的示例

    */

    public static void main(String[] args){

    // 这是单行注释的示例

    /* 这个也是单行注释的示例 */

    System.out.println("Hello World");

    }

    }

    展开全文
  • Java注释讲解

    2017-10-20 15:52:48
    Java注释的作用、种类

    注释

    1.注释的作用

    通过注释提高程序的可读性,是java程序的条理更加清晰,易于区分代码行与注释行。另外通常在程序开头加入作者,时间,版本,要实现的功能等内容注释,方便后来的维护以及程序员的交流。
    

    2.注释的种类

    a.单行注释(line comment)用//表示,编译器看到//会忽略该行//后的所文本
    b.多行注释(block comment)用/**/表示,编译器看到/*时会搜索接下来的*/,忽略掉/**/之间的文本。
    c.文档注释用/** */表示,是java特有的注释,其中注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档。
    
    public static void main(String[] args) {
                // 第一步: 获取半径?并将半径保存在程序中
                double radius = 5;
                // 第二步:计算面积,并将面积保存在程序中
                /*
                double area = radius * radius * 3.1415;
                // 第三步:在控制台现实面积
                System.out.println("半径为" + radius + "的圆的面积为:" + area);
                */
    
            }
    
       注意:多行注释中可以嵌套单行注释,多行注释不能嵌套多行注释。错误!!!
    
    class Demo{
            /*
                这是主函数,是程序的入口
                它的出现可以保证程序的独立运行
             /*
                注意:多行注释嵌套多行注释是不行的。
            */
            */
         public static void main(String[] args){
            //这是输出语句用于将括号内的数据打印到控制台。
            System.out.println("hello java");
        }

    d文档注释 (编写软件说明书)
    1.需要使用sum给我们提供的javadoc工具生成一个html的说明文档。
    2.只能抽取public的属性或者方法内容。
    格式:
    Javadoc –d 指定存储文档的路径 -version –author(可选) 目标文件

    @author 作者
    @version 版本
    @param 方法的参数
    @return 返回值
    

    注释的使用细节:
    三种注释可以出现在程序的任何地方,但是不推荐找任意位置。

    3.编程习惯

    1. 给那条语句进行说明,注释应该写在该语句的旁边。
    2. 单行注释一般写在语句的后面多行注释和文档注释一般写在语句的上面
    注意:文档注释只能出现在类、属性、方法的上面。
    

    3注释的嵌套
    单行注释可以在单行注释里面。
    多行注释不能嵌套在多行注释里面。

    4注释的调试作用:
    可以作为初学者的调试方式。
    可以帮组初学者确定代码的错误之处。

    展开全文
  • 今天系统学习一下Java注释(Java元数据)。本文内容不限于Javadoc注释。1.什么是Java元数据,有什么作用?元数据,就是“关于数据数据”。功能也有很多啦。你可能用过Javadoc注释自动生成文档。这就是元数据功能...
  • Java 注释

    万次阅读 2019-01-22 14:49:37
     程序注释的作用非常大,很多初学者在刚刚学习java程序的时候,会很努力的写程序,不太会注意添加注释。认为添加注释是一种浪费时间,没有意义的事情。经过一段时间的学习,注意到程序书写的不足,需要重构。于是...
  • 1常用Java注释标签(Java comment tags)@author作者@param输入参数的名称说明@return输出参数说明@since JDK版本@version版本号@see链接目标@throws异常@deprecated解释@link链接地址2 Java注释的使用顺序3简单常见的...
  • @[toc]一.注解的定义注解是一种为...注解不能直接干扰程序的运行注解的作用是把数据存储起来, 在某一个时刻去调用. 注解是继承自Annotation 二. 注解的作用作为特定的标记, 告知编译器一些信息. 例如方法的@Overr...
  • Java中@Autowired注释的作用 Spring2.5之后,可以使用@Autowired注解来实现DI(依赖注入),这个词本身的英文意思就是自动装配。 spring可以自动帮你把Bean里面引用的对象的setter/getter方法省略,它会自动帮你...
  • Java注释

    万次阅读 多人点赞 2019-09-28 22:23:28
    定义 用于解释说明程序的文字 分类 单行注释 格式: // 注释文字 ...注释的内容在程序编译的时候会被忽视,不会产生目标代码,注释的部分不会对程序的执行结果产生任何影响。 注意事项 多行和文档注释都不能...
  • 程序 中添加注释的目的是增强程序的可读性。Java提供3种注释方式:。单行注释://多行注释/**/文档注释:/***文档注释用于从源代码自动生成文档执行javadoc*命名根据源代码中的内容生成网页*@XXX */不同格式的注释可以...
  • Java注释模板设置eclipse中设置Java...Code Template然后展开Comments节点就是所有需设置注释的元素啦Java注释模板标签语法标签作用域说明@author类标明开发该类模块作者@version类标明该类模块的版本@see类, 属性...
  • public @interface TestA {//这里定义了一个空注解,它能干什么呢。我也不知道,但他能用。}在下面这个程序中使用它:package com.tmser.annotation;import java.util.HashMap;import java.util.Map;@TestA //使用...
  • JAVA注释

    2021-02-02 11:33:51
    单行注释和多行注释的作用: ①对所写的程序进行解释说明,增强可读性,方便自己方便别人 ②调试所写的代码 特点:单行注释和多行注释,注释了的内容不参与编译。换句话说,编译以后生成的.class结尾的字节码...
  • java注释

    2021-04-06 21:23:19
    注释的作用是什么? - 出现在java源程序当中,对java源代码的解释说明 - 注释不会被编译到.class字节码文件当中 - 一个好的开发习惯应该是多编写注释,这样程序的可读性较强。 *java中的注释怎么写? - ...
  • 单行/多行注释单行注释与多行注释的作用就不再赘, IDEA快捷键分别如下:command+/: 以//快速注释一行或多行 :// Integer[] array = new Integer[10];// for (int i = 0; i < array.length; ++i){// ...
  • 今天系统学习一下Java注释(Java元数据)。本文内容不限于Javadoc注释。1。什么是Java元数据,有什么作用?元数据,就是“关于数据数据”。功能也有很多啦。你可能用过Javadoc注释自动生成文档。这就是元数据功能...
  • 一、JAVA中的注释1.分类// 单行注释/* */ 多行注释/** */ 文档注释2....三类注释的比较作用域 注释位置 嵌套关系 备注单行注释 只在当前行有效 行的上面或者行尾 可以嵌套单行不可以嵌套多行多行...
  • Java 的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序,所以我们需要进行一些注释,可以是编程思路或者是程序的作用,总而言之就是方便自己他人更好的阅读。##注释类型...
  • 一.Java的注释类型 1.单行注释 2.多行注释 3.文档注释Java 符合) == 提高了代码阅读性 方便之后更改和查找 调试 调试程序重要方法== 注释是一个程序员必须要具备良好编程习惯 == 将自己思想通过注释...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 3,342
精华内容 1,336
关键字:

java注释的作用

java 订阅