精华内容
下载资源
问答
  • 对于Java语言最体贴的一项设计就是它并没有打算让人们为了写程序而写程序人们也需要考虑程序文档化问题对于程序文档化最大问题莫过于对文档维护若文档与代码分离那么每次改变代码后都要改变文档这无疑会变成...
  • 如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常重要的。注释除了帮助别人了解编写的程序之外,还对程序的调试、...

    一个程序的可读性,关键取决于注释。如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常重要的。

    注释除了帮助别人了解编写的程序之外,还对程序的调试、校对等有相当大的帮助。当程序具体运行时,计算机会自动忽略注释符号之后所有的内容。教程第二章中曾经提到过注释,读者也许印象不太深,在这里复习一遍。

    本节将简单地介绍类、方法、字段等地方的注释方法,这些地方的注释虽然简单但是在开发工作中却是非常重要的。

    注意:本节注释使用文档注释。多行注释的内容不能用于生成一个开发者文档(文档提供类、方法和变量的解释,也可称为帮助文档),而文档注释可以。

    1. 类注释

    类注释一般必须放在所有的“import”语句之后,类定义之前,主要声明该类可以做什么,以及创建者、创建日期、版本和包名等一些信息。以下是一个类注释的模板。

    /**

    * @projectName(项目名称): project_name

    * @package(包): package_name.file_name

    * @className(类名称): type_name

    * @description(类描述): 一句话描述该类的功能

    * @author(创建人): user

    * @createDate(创建时间): datetime

    * @updateUser(修改人): user

    * @updateDate(修改时间): datetime

    * @updateRemark(修改备注): 说明本次修改内容

    * @version(版本): v1.0

    */

    提示:以上以@开头的标签为 Javadoc 标记,由@和标记类型组成,缺一不可。@和标记类型之间有时可以用空格符分隔,但是不推荐用空格符分隔,这样容易出错。

    一个类注释的创建人、创建时间和描述是不可缺少的。下面是一个类注释的例子。

    /**

    * @author: zhangsan

    * @createDate: 2018/10/28

    * @description: this is the student class.

    */

    public class student{

    .................

    }

    注意:没有必要在每一行的开始用*。例如,以下注释同样是合法的:

    /**

    @author: zhangsan

    @createDate: 2018/10/28

    @description: this is the student class.

    */

    public class student{

    .................

    }

    2. 方法注释

    方法注释必须紧靠在方法定义的前面,主要声明方法参数、返回值、异常等信息。除了可以使用通用标签外,还可以使用下列的以@开始的标签。

    @param 变量描述:对当前方法的参数部分添加一个说明,可以占据多行。一个方法的所有 @param 标记必须放在一起。

    @return 返回类型描述:对当前方法添加返回值部分,可以跨越多行。

    @throws 异常类描述:表示这个方法有可能抛出异常。有关异常的详细内容将在第 10 章中讨论。

    下面是一个方法注释的例子。

    /**

    * @param num1: 加数1

    * @param num2: 加数2

    * @return: 两个加数的和

    */

    public int add(int num1,int num2) {

    int value = num1 + num2;

    return value;

    }

    以上代码的 add() 方法中声明了两个形参,并将它们两个的和作为返回值返回。

    为类的构造方法添加注释时,一般声明该方法的参数信息,代码如下。

    public class Student {

    String name;

    int age;

    /**

    * @description: 构造方法

    * @param name: 学生姓名

    * @param age: 学生年龄

    */

    public Student(String name,int age) {

    this.name = name;

    this.age = age;

    }

    }

    3. 字段注释

    字段注释在定义字段的前面,用来描述字段的含义。下面是一个字段注释的例子。

    /**

    * 用户名

    */

    public String name;

    也可以使用如下格式:

    /**用户名*/

    public String name;

    在 Java 的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序。注释对于程序的可读性来说是非常重要的,希望读者不要忽视它。

    展开全文
  • Java的类/方法/字段注释详解

    千次阅读 2020-04-04 15:45:50
    如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常重要的。 注释除了帮助别人了解编写的程序之外,还对程序的调试...

    一个程序的可读性,关键取决于注释。如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常重要的。

    注释除了帮助别人了解编写的程序之外,还对程序的调试、校对等有相当大的帮助。当程序具体运行时,计算机会自动忽略注释符号之后所有的内容。教程第二章中曾经提到过注释,读者也许印象不太深,在这里复习一遍。

    本节将简单地介绍类、方法、字段等地方的注释方法,这些地方的注释虽然简单但是在开发工作中却是非常重要的。
    注意:本节注释使用文档注释。多行注释的内容不能用于生成一个开发者文档(文档提供类、方法和变量的解释,也可称为帮助文档),而文档注释可以。

    1 类注释

    类注释一般必须放在所有的“import”语句之后,类定义之前,主要声明该类可以做什么,以及创建者、创建日期、版本和包名等一些信息。以下是一个类注释的模板。

    /**
     * @projectName(项目名称): project_name
     * @package(包): package_name.file_name
     * @className(类名称): type_name
     * @description(类描述): 一句话描述该类的功能
     * @author(创建人): user 
     * @createDate(创建时间): datetime  
     * @updateUser(修改人): user 
     * @updateDate(修改时间): datetime
     * @updateRemark(修改备注): 说明本次修改内容
     * @version(版本): v1.0
     */
    提示:以上以@开头的标签为 Javadoc 标记,由@和标记类型组成,缺一不可。@和标记类型之间有时可以用空格符分隔,但是不推荐用空格符分隔,这样容易出错。
    
    一个类注释的创建人、创建时间和描述是不可缺少的。下面是一个类注释的例子。
    /**
     * @author: zhangsan
     * @createDate: 2018/10/28
     * @description: this is the student class.
     */
    public class student{
        .................
    }
    

    注意:没有必要在每一行的开始用*。例如,以下注释同样是合法的:

    /**
       @author: zhangsan
       @createDate: 2018/10/28
       @description: this is the student class.
     */
    public class student{
        .................
    }
    

    2. 方法注释

    方法注释必须紧靠在方法定义的前面,主要声明方法参数、返回值、异常等信息。除了可以使用通用标签外,还可以使用下列的以@开始的标签。
    @param 变量描述:对当前方法的参数部分添加一个说明,可以占据多行。一个方法的所有 @param 标记必须放在一起。
    @return 返回类型描述:对当前方法添加返回值部分,可以跨越多行。
    @throws 异常类描述:表示这个方法有可能抛出异常。有关异常的详细内容将在第 10 章中讨论。

    下面是一个方法注释的例子。

    /**
     * @param num1: 加数1
     * @param num2: 加数2
     * @return: 两个加数的和
     */
    public int add(int num1,int num2) {
        int value = num1 + num2;
        return value;
    }
    

    以上代码的 add() 方法中声明了两个形参,并将它们两个的和作为返回值返回。

    为类的构造方法添加注释时,一般声明该方法的参数信息,代码如下。

    public class Student {
       String name;
       int age;
       /**
        * @description: 构造方法
        * @param name: 学生姓名
        * @param age: 学生年龄
        */
       public Student(String name,int age) {
        this.name = name;
        this.age = age;
       }
    }
    
    1. 字段注释
      字段注释在定义字段的前面,用来描述字段的含义。下面是一个字段注释的例子。
    /**
     * 用户名
     */
    public String name;
    

    也可以使用如下格式:

    /**用户名*/
    public String name;
    

    在 Java 的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序。注释对于程序的可读性来说是非常重要的,希望读者不要忽视它。

    展开全文
  • 一个程序的可读性,关键取决于注释。如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,...多行注释的内容不能用于生成一个开发者文档(文档提供、方法和变量的解释,也可称为帮助...

    一个程序的可读性,关键取决于注释。如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常重要的。

    我们会简单地介绍类、方法、字段等地方的注释方法,这些地方的注释虽然简单但是在开发工作中却是非常重要的。
    注意:本节注释使用文档注释。多行注释的内容不能用于生成一个开发者文档(文档提供类、方法和变量的解释,也可称为帮助文档),而文档注释可以。

    1. 类注释
    类注释一般必须放在所有的“import”语句之后,类定义之前,主要声明该类可以做什么,以及创建者、创建日期、版本和包名等一些信息。以下是一个类注释的模板。

    /**
     * @projectName(项目名称): project_name
     * @package(包): package_name.file_name
     * @className(类名称): type_name
     * @description(类描述): 一句话描述该类的功能
     * @author(创建人): user 
     * @createDate(创建时间): datetime  
     * @updateUser(修改人): user 
     * @updateDate(修改时间): datetime
     * @updateRemark(修改备注): 说明本次修改内容
     * @version(版本): v1.0
     */
    

    提示:以上以@开头的标签为 Javadoc 标记,由@和标记类型组成,缺一不可。@和标记类型之间有时可以用空格符分隔,但是不推荐用空格符分隔,这样容易出错。

    一个类注释的创建人、创建时间和描述是不可缺少的。下面是一个类注释的例子。

    /**
     * @author: zhangsan
     * @createDate: 2019/10/28
     * @description: this is the student class.
     */
    public class student{
        .................
    }
    

    注意:没有必要在每一行的开始用*。例如,以下注释同样是合法的:

    /**
       @author: zhangsan
       @createDate: 2018/10/28
       @description: this is the student class.
     */
    public class student{
        .................
    }
    

    2. 方法注释
    方法注释必须紧靠在方法定义的前面,主要声明方法参数、返回值、异常等信息。除了可以使用通用标签外,还可以使用下列的以@开始的标签。

    	@param 变量描述:对当前方法的参数部分添加一个说明,可以占据多行。一个方法的所有@param 标记必须放在一起。
    	
    	@return 返回类型描述:对当前方法添加返回值部分,可以跨越多行。
    	
    	@throws 异常类描述:表示这个方法有可能抛出异常。有关异常的详细内容将在第 10 章中讨论。
    

    下面是一个方法注释的例子。

    /**
     * @param num1: 加数1
     * @param num2: 加数2
     * @return: 两个加数的和
     */
    public int add(int num1,int num2) {
        int value = num1 + num2;
        return value;
    }
    

    以上代码的 add() 方法中声明了两个形参,并将它们两个的和作为返回值返回。

    为类的构造方法添加注释时,一般声明该方法的参数信息,代码如下。

    public class Student {
       String name;
       int age;
       /**
        * @description: 构造方法
        * @param name: 学生姓名
        * @param age: 学生年龄
        */
       public Student(String name,int age) {
        this.name = name;
        this.age = age;
       }
    }
    

    3. 字段注释
    字段注释在定义字段的前面,用来描述字段的含义。下面是一个字段注释的例子。

    /**
     * 用户名
     */
    public String name;
    

    也可以使用如下格式:

    /**用户名*/
    public String name;
    

    在 Java 的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序。注释对于程序的可读性来说是非常重要的,希望大家不要忽视它。

    展开全文
  • JAVA程序几种注释

    2019-05-22 13:27:14
    java程序注释分为三: // ……单行注释。...我们来用一个简单程序测试一下。 首先写一个HelloWorld.java文件 运行该程序,将java-d c:\help-author-version HellowWorld.java此段命令输入命令行,点击回...

    java程序注释分为三类:
    // ……单行注释。
    /* … / 多行注释,注释内容不会出现在javadoc 生成的文档中。
    /
    * … */ 多行注释,注释内容写入javadoc生成的文档。
    我们来用一个简单程序测试一下。
    首先写一个HelloWorld.java文件

    运行该程序,将java-d c:\help-author-version HellowWorld.java此段命令输入命令行,点击回车,之后就可以在c盘中找到名为help的文件夹并打开,找到index.html文件打开就会出现
    你就会发现双星注释的内容显示在页面中,而单行注释和单星多行注释都未显示在页面。在这里插入图片描述在这里插入图片描述

    展开全文
  • 为达到这个目的,最简单的方法是将所有内容都置于同一个文件。然而,为使一切都整齐划一,还必须使用一种特殊的注释语法,以便标记出特殊的文档;另外还需要一个工具,用于提取这些注释,并按有价值的形式将其展现...
  • 一个程序的可读性,关键取决于注释。如果一个程序想二次开发,要读懂前面的...本节将简单地介绍、方法、字段等地方的注释方法,这些地方的注释虽然简单但是在开发工作中却是非常重要的。 注意:本节注释使用文档注
  • 写代码的时候,有时候,你需要写一些注释...不管他具体有什么功能,咱就只管一个,他可以链接代码,让注释看的更清楚易懂。方便你我他。 @see 标签允许用户引用其他类的文档。具体使用方式如下: @see classname @see
  • 如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常重要的。注释除了帮助别人了解编写的程序之外,还对程序的调试、...
  • java类注释文档编写方法

    千次阅读 2011-05-01 23:52:00
    为达到这个目的,最简单的方法是将所有内容都置于同一个文件。然而,为使一切都整齐划一,还必须使用一种特殊的注释语法,以便标记出特殊的文档;另外还需要一个工具,用于提取这些注释,并按有价值的形式将其展现...
  • Java 类注释文档编写方法

    千次阅读 2014-12-03 10:36:09
    对于Java语言,最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程序的...为达到这个目的,最简单的方法是将所有内容都置于同一个文件。然而,为使一切都整齐划一,还必须使用一种特殊的注
  • 前阵子重装了系统,不得不重新下一遍idea,但是这次新建了.java文件之后居然是空白的文件,之前会加一些自动生成的注释...关于idea注释模板的教程网上有很多了,不再赘述,这里给出一个简单的例子,直接在Files选项卡里
  • java代码注释

    2018-02-18 10:35:50
    定义:java代码的注释就是备注功能:为了提高代码的可读性分类:单行注释、多行注释、文档注释单行注释:就是指只注释段代码比如:int number;...比如:/**注释内容*/总结:代码的注释简单来说...
  • 文章来源:csdn 作者:chensheng913对于Java语言,最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程序的文档化问题。...为达到这个目的,最简单的方法是将所有内容都置于同一个文件...
  • Java编程老鸟潜心写作,奉献高效率的Java学习心得 完全站在没有编程经验读者的角度,手把手教会读者学习Java 配16小时多媒体教学视频,高效、直观 一一击破Java入门可能会遇到的难点和疑惑 抽丝剥茧,层层推进,让...
  • 写代码的时候,有时候,你需要...不管他具体有什么功能,咱就只管一个,他可以链接代码,让注释看的更清楚易懂。方便你我他。 @see 标签允许用户引用其他类的文档。具体使用方式如下: @see classname @see fully-...
  • Java编程老鸟潜心写作,奉献高效率的Java学习心得 完全站在没有编程经验读者的角度,手把手教会读者学习Java 配16小时多媒体教学视频,高效、直观 一一击破Java入门可能会遇到的难点和疑惑 抽丝剥茧,层层推进,让...
  • Java编程老鸟潜心写作,奉献高效率的Java学习心得 完全站在没有编程经验读者的角度,手把手教会读者学习Java 配16小时多媒体教学视频,高效、直观 一一击破Java入门可能会遇到的难点和疑惑 抽丝剥茧,层层推进,让...
  • 程序员的第一个java程序——“helloword” 先上代码,很简单的一段语法只是一个简单的输出语句打印输出一行字符串“HelloWord”该程序包括三个部分:程序注释定义、main()方法。通过这三部分的说明应该理解...
  • 张帅帅学Java注释

    2019-08-08 20:41:22
    那我们先了解一下注释分类: 1.单行注释 //注释内容 ...这示例比较简单,主要是方便理解。 之前有看到过篇文章说程序员最讨厌两件事: 写注释 别人不写注释 认为不需要写注释程序员觉得,写...
  • 一、注释 1、注释形式 在以后所编写程序代码之中都要求加上注释,在程序中一共支持三注释: (1)单行注释://注释内容 (2)多行注释:/* 注释内容 / ...Java一个未使用到关键字:goto; Java
  • 今天学习类的创建以及Class Type和类的关系等等,内容比较简单我就把知识点写在了代码的注释上,程序仅供参考; 总结一下要点: 1.Java中任何一个类都是Class类的实例对象 2.一个类只可能是一个Class类的一个实例对象...
  • 如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常重要的。注释除了帮助别人了解编写的程序之外,还对程序的调试、...
  • 简单的FileQAQ

    2020-12-09 18:08:09
    Java File简述欢迎使用Markdown编辑器新改变功能快捷键合理创建标题,有助于目录生成如何改变文本样式插入链接与图片如何插入一段漂亮代码片生成一个适合你列表创建一个表格设定内容居中、居左、居右...
  • 这篇博文也是博主复习一下之前学过 Java 相关内容,通过使用 Java的类、对象、构造器、set和get方法、接口、重写、集合(泛型)等一些相对来说不算太难知识,来实现一个简易学生信息管理系统。我写...
  • 对于Java语言,最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程序的文档化问题。...为达到这个目的,最简单的方法是将所有内容都置于同一个文件。然而,为使一切都整齐划一...
  • 博客中的注释只是简单说明功能,具体使用方法见源码注释 源码下载 GitHub 很久很久之前,有时在处理一些字符串时总是不太满意,当时还没有了解到网上的一些好用的三方工具,所以就自己整理了一套工具,...

空空如也

空空如也

1 2 3 4 5 ... 11
收藏数 202
精华内容 80
关键字:

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

java 订阅