java注释分以下三种注释:
1、单行(single-line)--短注释://……
2、块(block)--块注释:/*……*/
3、文档注释:/**……*/
一、单行注释
1、单行注释(Single-Line Comments):
短注释可以显示在一行内,并与其后的代码具有一样的缩进层级。
如果一个注释不能在一行内写完,就该采用块注释。
单行注释之前应该有一个空行。
例:
if (condition) {
/* Handle the condition. */
...
}
eclipse快捷键:Ctrl+Shift+/Ctrl+Shift+\
2、尾端注释(Trailing Comments):
尾端(trailing)--极短的注释,在代码行的行尾进行注释。
建议:一般与代码行后空8(至少4)个格,所有注释必须对齐。
例:
if (a == 2) {
return TRUE; /* special case */
} else {
return isPrime(a); /* works only for odd a */
}
eclipse快捷键:Ctrl+Shift+/Ctrl+Shift+\
3、行末注释:
在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式:// 注释内容
建议:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。
如:
风格一:
if (foo > 1) {
// Do a double-flip.
...
}
else {
return false; 风格二:// Explain why here.
}
风格三:
//if (bar > 1) {
//
// // Do a triple-flip.
// ...
//}
//else {
// return false;
//}
Ctrl+Shift+C 或者 Ctrl+/ 再按一次取消
二、块注释
注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成:
快捷键:Ctrl+Shift+/ Ctrl+Shift+\
三、文档注释
注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符
avadoc注释标签语法
1、接口或类中使用
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@deprecated:不推荐使用的方法或类
2、方法中使用
@deprecated:不推荐使用的方法
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
@throws 同exception
3、字段上使用
@deprecated:不推荐使用的方法
@see 对类、属性、方法的说明 参考转向,也就是相关主题
1、开头注释(Beginning Comments)
所有的源文件都应该在开头有一个C语言风格的注释,其中列出类名、版本信息、日期和版权声明:
/*
* Classname
*
* Version information
*
* Date
*
* Copyright notice
*/
2、包和引入语句(Package and Import Statements)
我常用的快捷键:Ctrl+Shift+O
3、类和接口声明(Class and Interface Declarations)
快捷键:Alt+Shift+J
/**
* @Copyright
* @Description
* @author逍遥客
* @date 2013-5-23 上午12:43:22
* @version V1.0
*/
4、方法注释
声明好方法后,在向方法里写实现的代码前,在方法前
/** 回车
相关推荐
Java基础每日复习笔记-JavaSE高级阶段.2020-10-13-211312.edf
Sim-to-Real: Learning Agile Locomotion For Quadruped Robots笔记 Sim-to-Real: Learning Agile Locomotion For Quadruped Robots笔记 Sim-to-Real: Learning Agile Locomotion For Quadruped Robots 笔记
Java基础每日复习笔记-JavaSE基础阶段.edf
Java基础每日复习笔记-JavaSE高级阶段.edf
王光庆的专插本高等数学笔记- 第1章: 函数、极限与连续
python笔记50-面试题:交换圣诞节礼物全文共5页,当前为第1页。python笔记50-面试题:交换圣诞节礼物全文共5页,当前为第1页。python笔记50-面试题:交换圣诞节礼物 python笔记50-面试题:交换圣诞节礼物全文共5页,...
20210823-国盛证券-食品饮料行业:酒类行业研究笔记.pdf
Java笔记---李兴华---Java笔记---李兴华-----Java笔记---李兴华--Java笔记---李兴华
java笔记-------------java笔记-------------java笔记-------------
java鼠标监听器源码Java笔记 :writing_hand: 阿琼·阿迪卡里 Java 是一种通用计算机编程语言,它是并发的、基于类的、面向对象的,并且专门设计为具有尽可能少的实现依赖性。 匆忙 ? 基本 :fast-forward_button: :...
笔记该项目使用Spring Data Neo4j6。仍然可以在下访问使用SDN 5 + OGM的先前版本。分支。 笔记有关具有相同数据集的Spring Data Neo4j 6的更广泛概述,可以访问分支。 上详细描述了示例项目。 该项目使用Java 11。...
李航《统计学习方法》笔记 --从原理到实现:基于R.pdf
---Java笔记---
嵌入式开发学习笔记 ( java - c/c++ :从入门到入门 ) 叙述了我从小白到入门过程中遇到的问题以及解决方法(2018更新版)。
《Java高级复习笔记-程序阅读题.docx》是一份宝贵的学习资源,特别适合那些希望深入理解和掌握Java高级编程概念的学习者和开发者。以下是对这个资源的详细描述: 深度理解编程概念:这份文档提供了一系列程序阅读...
华为笔试题java 潜在的迪斯科 网页浏览 笔记-url2.nto ::: -- -- -- -- -- -- -- -- -- -- ::: <<<< :: -- -- -- -- -- -- -- -- -- - -- ::: >>>> 来自其他设备的 Chrome 标签 chrome://history/...
Jsp-Servlet复习笔记-----第3章 Servlet技术 - 堕落天使 - JavaEye技术网站.mhtJsp-Servlet复习笔记-----第3章 Servlet技术 - 堕落天使 - JavaEye技术网站.mht