JAVA的编程风格

    注意大括号位置！

    Loops
    while-loop语法如下：

    for-loop语法如下：

    注意大括号位置！仅一条声明时大括号省略：

    例如，我们写一个procedure写出1到10这十个数字：

    try-catch语法形如：

    如果try-catch语句后跟随finally子句则形如：

    新行

    每一行最好只阐述一件事情。比如，一行包含一个声明、一个条件语句、一个循环等。不论多小，最好不要一行办两件事及以上。例如不要把一个if表达式或循环语句的主体放置在同一行，这样的表达式断行的易读性会更高。通常，互相协作的代码应放在一起，为保证代码美观可读，我们应将代码的不同代码段放置在不同的段落。不过要牢记断行不要太过分！比如:

    给自己的代码加入注释

    注释就是类的描绘、方法存在的原因、它完成了什么以及它对它其中（变量）的作用域。假定阅读你代码的人已经知道这是什么语言，所以不需要注释语句功能，尽量使用简短而有描述力的注释。

    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 n  a description of the parameter
* @return   a description of the return value
*/
public int factorial(int n) {


    某些不是全部，被JavaDoc注释区域如：

/**
* Short description of the variable (one line)
*/
type variable;