锐客网

  1. 首页 > 睿知 > it技术 > >

java代码块流行风格 java代码块的用处(11)

IT技术代码


public int factorial(int n) {
int result = 1;
for(int i = 1; i = n; i++)
result*=i;
return result;
}
给自己的代码加入注释
注释就是类的描绘、方法存在的原因、它完成了什么以及它对它其中（变量）的作用域 。假定阅读你代码的人已经知道这是什么语言，所以不需要注释语句功能 ， 尽量使用简短而有描述力的注释 。
Java有两种类型的注释：
//This is a comment that continues until the end of the line.
/* This is a comment. It goes on and on and on and on and on and on and on
and on and on and on and on and on and on and on and on and on and on and
on and on and on and on and on and on and on and on and ends like this: */
/**
* This is a JavaDoc comment. More about JavaDoc in the next section.
*/
如果在注释中加入注释则会出错：
/* You are not allowed to do anything like this /* because the compiler will
complain, if you are lucky */ DON'T DO THIS! And don't write comments in
upper case either... */
注释应放在它要解释内容上下 ， 这样会让代码更易于理解 。
不要注释一些语言的语句功能：
i++;// Add 1 to i
更不要让自己的代码处于这种状态：
for(int i = 1; i = n; i++)
/* don't place comments where
they don't belong */
result*=i;
较短的注释既可被放在被注释代码上下，而长注释则习惯性的放在代码之上：
/* Comments can be placed before the
block that is to be commented */
for(int i = 1; i = n; i++)
result*=i;
或者:
for(int i = 1; i = n; i++){
result*=i;// short comments can be placed like this
tmp++;// if necessary, they continue here
}
不要写没用的注释：
i++;// change this later
Excuse me,这句肯定是胡扯！
不要写自己都看不懂的注释：
i++;// BMW
BMW? 如果你能连续十天记住这是什么意思的话，那么你的记忆真是不错了 。所以不要写没人能看懂的注释 ， ok？
最后重申一下：写简短而富于描述性的注释，把它们放在该放的地方，而不要考验你自己的记忆力！
JavaDoc - 文档工具
JavaDoc不仅是另一种给代码加注释的仿佛咱，更是一个文档工具 。类、方法和一些重要地方需要用JavaDoc来注释 。这并不是说你可以放弃常规的注释，这两者在代码中应该是相辅相成、互相弥补的关系 。
类被注释如：
/**
* Car represents cars ... A description of the class
* should be place here. Note that the description begins
* on the second line and that there is a space between
* the asterix and the text. Next we will add some fields
* indicating who the authors of the class are and
* other useful information. Notice the newline!
*
* @author Jerry Meng
* @version %I%, %G%
*/
public class Car {
注意JavaDoc结束和类开始间无空行 。
方法被注释如：
/**
* A description of what the method does...
*
* @param na description of the parameter
* @returna description of the return value
*/
public int factorial(int n) {
某些不是全部，被JavaDoc注释区域如：
/**
* Short description of the variable (one line)
*/
type variable;
什么应当使用JavaDoc做注释？如何注释的恰当呢？
可以这样想，JavaDoc中所作的注释都可以在类的文档中看到 。所有读这个类的文档的读者都会明白这个类所完成的功能、它包括的方法、如何使用这些方法及方法的返回值 。一些作用域，比如public的变量或常量将会一目了然 。任何不了解这个类内部结构的人都可以轻松的调用它 。这便是你用JavaDoc可以轻松提供的信息 。而使用一般注释的地方，一般是给那些可能修改你的类代码的程序员，它们一般描述了类的内部信息和结构 。

推荐阅读


上一篇：电脑怎么连接faceu，电脑怎么连接无线网

下一篇：直播同城推送技巧，直播同城怎么打开