文档章节

Java学习笔记(13)——Java注释

IT特种兵
 IT特种兵
发布于 2015/04/30 12:33
字数 438
阅读 27
收藏 0

java中的注释分:

  • 实现注释和文档注释。实现注释和在C语言里的一样,采用/*....*/ 和 // 进行的注释;

  • 而文档的注释应该说是java里面独有的,采用的是/**....*/,Sun公司开发的Javadoc工具可以识别出这类文档注释将其转化成HTML文件。

下面先看文档注释。

  1. 文件注释:写在文件头部,包名之前的位置。范例如下。

/**
 * 文件名: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
 */


© 著作权归作者所有

IT特种兵
粉丝 19
博文 103
码字总数 136362
作品 0
长宁
高级程序员
私信 提问
Groovy轻松入门——通过与Java的比较,迅速掌握Groovy

Groovy和Java的相同点有: 3+, 4+, 6+, 8+, 10+, 12+, 13, 14, 15, 18+, 20+, 21, 22, 23, 28+, 29+, 30+, 31+, 32+ +表示Groovy不但涵盖了Java的语法,而且还有增强部分。 Groovy和Java的不...

DavidBao
2015/05/15
1K
0
Java 私塾第一、二章笔记整理

Java 私塾第一、二章笔记整理 第一章 java入门 一.Java是什么? 一种计算机编程语言 一种软件开发平台 一种软件运行平台(JRE :java runtime environment) 一种软件部署环境 二.Java版本:...

luodis
2011/01/14
261
2
【Java学习路线】新手该如何一步步的学习 Java

新手该如何一步步的学习 Java? 如果真的想学Java,最好要循序渐进,有章有法的学习它! 今天小慕就不说一些学习方法和技巧了,直接来谈每个阶段要学习的内容。 首先,给大家分享一张以 企业...

Eddie_yang
2018/11/15
2.1K
0
maven版本与jdk版本 对应关系

Release Date Version Required Java Version 2017/10/24 3.5.2 Java 7 2017/4/7 3.5.0 Java 7 2017/3/24 3.5.0-beta-1 Java 7 2017/2/28 3.5.0-alpha-1 Java 7 2015/11/14 3.3.9 Java 7 201......

晨猫
2018/02/07
35
0
201709记录(elasticsearch)

1 Easy Go Programming Setup for Windows http://www.wadewegner.com/2014/12/easy-go-programming-setup-for-windows/ 2 本地计算机上的mysql服务启动停止后,某些服务在未由其他服务或程序......

bapleliu
2017/09/01
3
0

没有更多内容

加载失败,请刷新页面

加载更多

Spring Boot + Mybatis-Plus 集成与使用(二)

前言: 本章节介绍MyBatis-Puls的CRUD使用。在开始之前,先简单讲解下上章节关于Spring Boot是如何自动配置MyBatis-Plus。 一、自动配置 当Spring Boot应用从主方法main()启动后,首先加载S...

伴学编程
昨天
7
0
用最通俗的方法讲spring [一] ──── AOP

@[TOC](用最通俗的方法讲spring [一] ──── AOP) 写这个系列的目的(可以跳过不看) 自己写这个系列的目的,是因为自己是个比较笨的人,我曾一度怀疑自己的智商不适合干编程这个行业.因为在我...

小贼贼子
昨天
7
0
Flutter系列之在 macOS 上安装和配置 Flutter 开发环境

本文为Flutter开发环境在macOS下安装全过程: 一、系统配置要求 想要安装并运行 Flutter,你的开发环境需要最低满足以下要求: 操作系统:macOS(64位) 磁盘空间:700 MB(不包含 IDE 或其余...

過愙
昨天
6
0
OSChina 周六乱弹 —— 早上儿子问我他是怎么来的

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @凉小生 :#今日歌曲推荐# 少点戾气,愿你和这个世界温柔以待。中岛美嘉的单曲《僕が死のうと思ったのは (曾经我也想过一了百了)》 《僕が死の...

小小编辑
昨天
2.7K
16
Excption与Error包结构,OOM 你遇到过哪些情况,SOF 你遇到过哪些情况

Throwable 是 Java 中所有错误与异常的超类,Throwable 包含两个子类,Error 与 Exception 。用于指示发生了异常情况。 Java 抛出的 Throwable 可以分成三种类型。 被检查异常(checked Exc...

Garphy
昨天
42
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部