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

    2019-06-19 00:20:37
    Java的注释有两种方式:单行注释 // 和 块注释 /* */ Java的注释按位置分为四种,分别放在四个地方 标题注释(Title comments) 介绍性注释 块注释 单行注释 1.标题注释 标题注释放在文件开始的地方,从第一行开始. ...

    注释(comments)

    Java的注释有两种方式:单行注释 // 和 块注释 /* */

    Java的注释按位置分为四种,分别放在四个地方

    1. 标题注释(Title comments)
    2. 介绍性注释
    3. 块注释
    4. 单行注释

    1.标题注释

    标题注释放在文件开始的地方,从第一行开始.

    标题注释通常包括版权信息

    在这里插入图片描述

    2.介绍性注释

    在包导入声明(import)的下方,类声明的上方.

    主要介绍类的意图,功能和使用方法.

    在这里插入图片描述

    3.块注释

    块注释放在类主体之中.

    用于说明一块代码(多行相关代码)的作用

    在这里插入图片描述

    4.单行注释

    放在一条语句的上方或者后面

    用于解释一行语句的作用,通常放在调用函数后或者逻辑的复杂语句后面

    在这里插入图片描述

    那些地方需要注释

    1. 文件开始必须写注释,告诉读者这个文件是什么,做什么用的,以及可能加上版权信息
    2. 每一个类声明的时候应当有注释,解释这个类是做什么用的.注意同一个文件中可能有多个类,如内部类,这些类都需要写注释以表明他们的作用.
    3. 每一个方法,应当写注释
    4. 每一个变量创建时,特别是类的成员变量,应当写注释解释这个变量扮演的角色
    5. 涉及复杂的算法时,应当为每一行写注释
    6. 规格说明,前置条件和后置条件
    7. 创建成员变量后的一系列单行注释说明: RI ,AF,表示不变性,防止表示泄露的策略
    8. 如何确保线程安全需要写注释说明
    9. 测试类中,需要用块注释写测试策略

    图: RI,AF ,防止表示泄露策略

    在这里插入图片描述

    下图:线程安全的策略

    在这里插入图片描述

    下图:用块注释写测试策略

    在这里插入图片描述

    展开全文
  • java开发中两种注释的用法 学习产出: //TODO description 标识处功能代码待编写,description为描述 //FIXME description 标识处代码需要修正,甚至代码是错误,不能工作,需要修复,description为描述 .....

    学习内容:

    java开发中两种注释的用法

    学习产出:

    //TODO description
    标识处有功能代码待编写,description为描述
    在这里插入图片描述

    //FIXME description
    标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,description为描述
    在这里插入图片描述

    展开全文
  • 在C/C++,JAVA中,有两种注释,一种是单行注释,即两根反斜杠(//),另一种是多行注释,即以/*开头,以*/结尾。在Java中,多行注释(Multiline Comment)分为两种形式:1.普通多行注释,比如/**多行注释*/2.Javadoc注释,...

    在C/C++,JAVA中,有两种注释,一种是单行注释,即两根反斜杠(//),另一种是多行注释,即以/*开头,以*/结尾。

    在Java中,多行注释(Multiline Comment)分为两种形式:

    1.普通多行注释,比如

    /*

    *多行注释

    */

    2.Javadoc注释,比如

    /**

    *Javadoc注释

    */

    当Java源文件编译的时候,Javadoc工具会读取源文件当中的Javadoc注释内容,并生成相应的HTML文档。供开发者参阅API相关的内容。

    在C#中采用了另外一种形式,即XML。

    为了能够在编译过程中生成XML文档,需要一种来标记来标注注释。即三根反斜杠。

    下面是一个简单的例子:

    namespace MyNameSpace

    {

    ///

    /// 这是一个普通的类

    ///

    public class Person

    {

    ///

    /// 这是标识的ID

    ///

    public string Id { get; protected set; }

    ///

    /// 这是姓名

    ///

    public string Name { get; set; }

    ///

    /// 这是年龄

    ///

    public int Age { get; set; }

    ///

    /// 这是构造函数

    ///

    /// ID

    /// 姓名

    /// 年龄

    public Person(string id, string name, int age)

    {

    this.Id = id;

    this.Name = name;

    this.Age = age;

    }

    ///

    /// 介绍自己啦

    ///

    public void IntroduceMyself()

    {

    Console.WriteLine("My name is {0}, My age is {1}", Name, Age);

    }

    ///

    /// 计算两者之和

    ///

    /// 左操作数

    /// 右操作数

    /// 两者和

    public int calculate(int a, int b)

    {

    return a + b;

    }

    ///

    /// 讲话啦

    ///

    /// 讲的内容

    public void saySomething(string msg)

    {

    Console.WriteLine(msg);

    }

    }

    }

    编译该文件:  csc /doc:test.xml test.cs

    查看生成的XML文档:

    MyNameSpace

    这是一个普通的类

    这是构造函数

    ID

    姓名

    年龄

    介绍自己啦

    计算两者之和

    左操作数

    右操作数

    两者和

    讲话啦

    讲的内容

    这是标识的ID

    这是姓名

    这是年龄

    如果是在VISUAL STUDIO,需在项目属性的生成选项卡中选中生成XML文件,并指定路径和文件名。

    5b20ac668176235f814e327c384461f3.png

    这样,当您在使用相应的类或者方法时,我们利用IDE自带的提示工具查看该类或该方法的简要:

    5c0fc8a787d3ba211ffcdab3aaf1a801.png

    展开全文
  • java两种注释方法

    2020-06-04 15:10:24
    助于目录生成如何改变文本样式插入链接与图片如何插入一段漂亮代码片生成一个适合你列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少KaTeX数学...

    1://---- 单行注释
    2:/------/多行注释(多行注释不可嵌套)

    展开全文
  • 我为其他用户推出了一堆upvote,但只是给我的两美分,我使用唯一三个注释与开发中任何规律是编译器直接使用主要注释:@Override – 当您覆盖另一方法时,非常适合在代码中显式显示。如果您不以您认为方式...
  • 所有javadoc命令都只能出现于“/**”注释中。但和平常一样,注释结束于一个...类型的注释文档,它们对应于位于注释后面的元素:类、变量或者方法。也就是说,一个类注释正好位于一个类定义之前;变量注释正好...
  • java 注释方法_Java注释

    2021-03-05 22:07:43
    Java注释的类型在Java3类型的注释。它们分别如下 -单行注释多行注释文档注释1)Java单行注释单行注释仅用于注释一行,它使用的是 // 个字符作为一行注释的开始,如下语法所示 -语法:// This is sing...
  • */ 注释若干行,并写入 javadoc 文档通常这种注释多行写法如下:/*** .........* .........*/很多人多忽视了这第三注释,那么这第三种注释有什么用?javadoc 又是什么东西?下面我们就谈谈。一. Java 文档和 ...
  • java的注释有三 单行注释 多行注释 文档注释 单行注释和多行注释比较好理解,直接贴例子 // 这里是单行注释 /* 这里是多行注释 */ 文档注释,是java特有的注释方法,作用有两点: ...
  • 在说道主题前,先来啰嗦句,o()︿︶)o 唉,不说句心里就个疙瘩,也许这就是所谓强迫症吧,好了说说我想啰嗦,其实也就是这样子,关于Java开发工具箱下载以及环境配置。Java开发工具箱下载进入到...
  • 1. Java的注释Java里有两种注释风格。下面这个写法是非常常见的还可以写成:第二种写法如下:2. Java的嵌入式文档通常,我们把注释和代码都放到了同一个文件example.java里面,这是为了更好地维护Java文件的注释,...
  • JAVA有两种注释风格,一种是传统的C语言风格的注释 以“/*“开始,随后是注释内容,最后以”/*“结束。注意,许多程序员在连续的注释内容的每一行都以一个“*”开头,经常看到像下面的写法:/*This is a comment *...
  • 一、Java中注释地位 ...在Java中,注释有两种,分别为单行注释和多行注释。 其中,单行注释只可以注释一行程序,并且注释内容不会写入在javadoc生成文档中,其格式为: 而多行注释又分为注释内容不会写入ava...
  • import java.util.Random; public class 随机数 { public static void main(String[] agrs){ //第一方法导包,给随机数r确定对象 Random r=new Random(); //给对象赋值0-99随机数并赋值给变量a ...
  • JAVA的注释规范

    2010-03-21 20:57:00
    Java 的语法与 C++ 及为相似,Java 的注释有: // 注释一行 /* ...... */ 注释若干行不完全对,除了以上两种之外,还有第三种,文档注释: /** ...... */ 注释若干行,并写入 javadoc 文档注释要简单明了。String ...
  • Java的注释

    2019-05-21 21:58:26
    像其他编程语言一样,Java也...在Java中,单行注释和多行注释两种注释方式,其中多行注释单“*”注释和双“**”注释两种方式。 示例: 单行注释: public class HelloWorld{ public static void mai...
  • java的注释

    2018-08-28 15:29:00
    java中注释符有两种: 单行注释,以双斜杠//开头,直至换行 多行注释,以单斜杠/加星号*开头,星号*加斜杠/表示结束。 java的注释可以出现在源程序的任何位置。 javadoc注释 这种注释的语法是以“/**”...
  • 在说道主题前,先来啰嗦句,o()︿︶)o 唉,不说句心里就个疙瘩,也许这就是所谓的强迫症吧,好了说说我想啰嗦的,其实也就是这样子的,关于Java开发工具箱的下载以及环境的配置。Java的下载进入到oracle官网...
  • java注释

    2014-09-18 14:56:00
    定义这个规范的目的是让项目中所有...Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种? // 注释一行  /* ...... */ 注释若干行 不完全对,除了以上两种之外,还有第三种,文档注释: ...
  • java标注_java注释

    2021-03-07 01:57:34
    Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种?// 注释一行/* ...... */ 注释若干行不完全对,除了以上两种之外,还有第三种,文档注释:/** ...... */ 注释若干行,并...
  • 本文内容来自:Java的注释和Javadoc在eclipse生成...Java里有两种注释风格。下面这个写法是非常常见的 1 2 3 4 /*This is a comment *that continues *across lines
  • 注释说明:能在客户端显示一个注释,标记内所有JSP脚本元素、指令和动作正常执行,也就是说编译器会扫描注释代码。 HTML语法:注释--> 语法示例: 例1 这段注释显示在客户端浏览器页面中 -->...
  • JAVA文档注释1.1

    2016-10-11 17:10:58
     Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种?  // 注释一行 /* ...... */ 注释若干行  不完全对,除了以上两种之外,还有第三种,文档注释:  /** ...... */ 注释若干行,并...
  • 在C/C++,JAVA中,有两种注释,一种是单行注释,即两根反斜杠(//),另一种是多行注释,即以/*开头,以*/结尾。 在Java中,多行注释(Multiline Comment)分为两种形式: 1.普通多行注释,比如 代码如下:/* *多行注释 */2....

空空如也

空空如也

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

java的注释有两种

java 订阅