您的位置：首页 > 编程语言 > Java开发

方法说明JAVA复习笔记--前言：第一节：从注释开始

2013-05-25 14:21 295 查看

题记：写这篇博客要主是加深自己对方法说明的认识和总结实现算法时的一些验经和训教，如果有错误请指出，万分感谢。

java注释分以下三种注释：

1、单行(single-line)--短注释：//……
2、块(block)--块注释：/*……*/
3、文档注释：/**……*/

一、单行注释

1、单行注释(Single-LineComments)：

短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。

如果一个注释不能在一行内写完，就该采取块注释。

单行注释之前应该有一个空行。

例：

if(condition){

/*Handlethecondition.*/
...
}

eclipse快捷键：Ctrl+Shift+/Ctrl+Shift+\

2、尾端注释(TrailingComments)：

尾端(trailing)--极短的注释，在代码行的行尾停止注释。

提议：一般与代码行后空8（最少4）个格，所有注释必须对齐。

例：

if(a==2){
returnTRUE;/*specialcase*/
}else{
returnisPrime(a);/*worksonlyforodda*/
}
eclipse快捷键：Ctrl+Shift+/Ctrl+Shift+\

3、行末注释：

在代码行的开头停止注释。主要为了使该行代码得到意义。
注释格式：//注释内容

提议：在代码中单起一行注释，注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行没法完成，则应采取块注释。

如：

风格一：
if(foo>1){

//Doadouble-flip.
...
}
else{
returnfalse;风格二：//Explainwhyhere.
每日一道理

如果人类不好好保护我们这个赖以生存的地球，终有一天，风沙的肆虐与垃圾的堆积会吞没我们美丽的家园。我向全世界的人们呼吁：让我们从现在开始，从我做起，手挽手，肩并肩共同保护建设我们的家园吧！

}

风格三:
//if(bar>1){
//
////Doatriple-flip.
//...
//}
//else{
//returnfalse;
//}

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、开头注释(BeginningComments)

所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、版本信息、日期和版权声明：

/*
*Classname
*
*Versioninformation
*
*Date
*
*Copyrightnotice
*/

2、包和引入语句(PackageandImportStatements)

我经常使用的快捷键：Ctrl+Shift+O

3、类和接口声明(ClassandInterfaceDeclarations)

快捷键:Alt+Shift+J

/**
*@Copyright

*@Description
*@author逍遥客
*@date2013-5-23上午12:43:22
*@versionV1.0
*/

4、方法注释

声明好方法后，在向方法里写实现的代码前，在方法前

/**回车

文章结束给大家分享下程序员的一些笑话语录：

AdobeFlash拖垮Windows拖垮IE！又拖垮Linux拖垮Ubuntu拖垮FirxEox！还拖垮BSD拖垮MacOS拖垮Safri！简直无所不拖！AdobeFlash滚出网路世界！不要以为市占有率高就可以持续出烂货产品！以后替代品多得是！

---------------------------------
原创文章By
说明和类
---------------------------------

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签：

相关文章推荐

新的分享

章节导航