Java語言的寫作風格

Java語言的寫作風格

寫作Java程式時,請注意下列幾種風格

• Class Name請首字大寫
  
• Variable Name和Method Name請首字小寫
  
• 如果名稱由數個英文字組成,第二個英文字以後首字大寫
  
• 內縮四個空格
  
• 註解部分如要變成說明文件,請遵照javadoc這個工具的寫作規則
  

/**
* 第一行的兩個**用來告訴javadoc此部份註解要變成HTML文件的一部份
* 這段註解裡的所有文字都會變成此類別一開頭的說明
*/
public class Hello { // Class Name首字大寫
/**
* 此段註解會變成描述main方法的一部分
* @param argv 使用@param註記會產生參數(parameter)argv的相關說明
* @return 傳回值的意義說明
*/
public static void main(String[] argv) { // Method Name首字小寫
// argv: array of references to String object
int myVariable; // 變數宣告
int i, sum;
for (i = 1, sum = 0; i <= 100; i++) {
sum += i;
}
System.out.println("summation from 1 to 100 is "+sum);
}
}

轉貼自 http://programming.im.ncnu.edu.tw/J_index.html