Java学习笔记（13）—

为什么80%的码农都做不了架构师？>>>

java中的注释分：

实现注释和文档注释。实现注释和在C语言里的一样，采用/*....*/ 和 // 进行的注释；
而文档的注释应该说是java里面独有的，采用的是/**....*/，Sun公司开发的Javadoc工具可以识别出这类文档注释将其转化成HTML文件。

下面先看文档注释。

文件注释：写在文件头部，包名之前的位置。范例如下。

/*** 文件名：TestCode.java* 版权：Copyright 2014-2015 IBM.All Rights Reserved.* 描述: xxxxxxxx * 修改人：xxx* 修改时间：2014-5-12* 修改内容： xxxxxxx* /

2.类和接口的注释：放在package关键字之后，Class/Interface关键字之前。范例如下。

/*** * 注释内容* */

3.第2条中注释内容的格式：用一句话进行功能描述，根据需要列出：版本号、生成日期、作者、内容、功能、与其他类的关系等。如果类里存在bug，请如实说明这些bug。范例如下。

/*** （一句话功能简述）* （功能详细描述）* @author WangWu* @version[版本号，YYYY-MM-DD]* @see[相关类/方法]* @since[产品/模块版本]*/

注：@since表示从那个版本开始就有这个类或者接口

4.类、方法属性：共有、保护、私有的注释，写在类、方法声明之前。范例如下。

/*** 注释内容 */
private void write() {
}

5.在4中的注释内容为：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。范例如下。

/*** （一句话功能简述）* <功能详细描述>* @param [参数1][参数1说明]* @param [参数2][参数2说明]* @return[返回类型说明]* @exception/throws[违例类型][违例说明]* @see*/

转载于:https://my.oschina.net/jewill/blog/408518

Java学习笔记（13）——Java注释相关推荐

Java学习笔记1:Java中有关print、println、printf的用法和区别
Java学习笔记1:Java中有关print.println.printf的用法和区别最近在学习java,写一些笔记记录下. 1.print()函数是一般的标准输出,但是不换行. 2.println ...
Java学习笔记（java基础）
Java学习笔记(第一周) Java 介绍 Java 发展方向 JVM , JDK , JRE 名词解释 Java语言的特点 Java安装安装包的下载配置环境变量验证是否安装成功 Java的第一 ...
java学习笔记(13) 第13章 - 常用类
第13 章常用类-目录 13.1 包装类 13.1.1 包装类的分类.包装类和基本数据的转换.案例演示.课堂测试 13.1.2 包装类型和String 类型的相互转换 13.1.3 Integer 类 ...
【java】java学习笔记之java oop（面向对象）
如下图所示为笔者总结的java oop(面向对象)学习笔记,其中,附带有代码示例(未展开),方便理解记忆.需要源文件的请到我的资源中下载,下载地址:https://download.csdn.net/ ...
【java】java学习笔记之java常用类
如下图所示为笔者总结的java常用类学习笔记,其中,附带有代码示例(未展开),方便理解记忆.需要源文件的请到我的资源中下载,下载地址:https://download.csdn.net/downloa ...
Java学习笔记01—Java概述、数据类型、变量、标识符、类型转换
1. Java概述 1.1 Java语言发展史(了解) 语言:人与人交流沟通的表达方式计算机语言:人与计算机之间进行信息交流沟通的一种特殊语言 Java语言是美国Sun公司(Stanford Uni ...
Java 学习笔记(4)——java 常见类
上次提前说了java中的面向对象,主要是为了使用这些常见类做打算,毕竟Java中一切都是对象,要使用一些系统提供的功能必须得通过类对象调用方法.其实Java相比于C来说强大的另一个原因是Java中提供 ...
java学习笔记(一) ----java下常用的包功能
***java下常用的包*** java.lang----包含一些java语言的核心类,如String,Math,Integer,System,Thread,提供常用的功能. java.awt---- ...
Java学习笔记-7.Java IO流
一.输入/输出流 1.流:不同类型的输入.输出源数据流:输入或输出的数据 Java数据流的所有接口和类都是在java.io包中定义的,因此应在程序开头加入 import java.io.* 2 ...
JAVA学习笔记 03 - JAVA语言程序结构
本文是Java基础课程的第三课.计算机语言的程序结构无外乎顺序结构.分支结构.循环结构,本文主要介绍Java语言中这些程序结构是如何实现的文章目录一.程序结构二.分支结构 1.单分支if语句 2 ...

Java学习笔记（13）——Java注释

Java学习笔记（13）——Java注释相关推荐

最新文章

热门文章