3.8 空白
在前面的內容中,已經介紹了在編寫代碼中,單詞和單詞之間需要使用空格進行間隔,至於空格的數量則不限制。
而實際的編碼中,為了使代碼的結構清晰,一般需要在代碼的前面加入一定數量的空格,例如如下格式:
public class Blank{
public static void main(String[] args){
int n;
{
n = 10;
}
System.out.println(n);
}
}
在該代碼中,除了第一行和最後一行外,每行都包含一定數量的空格,這種編碼的格式稱為代碼縮進。
在實際代碼中,只要存在包含關系,則代碼就應該縮進,語句塊是最典型的包含關系之一。說明:在編譯時,每行開始的空格都會被忽略掉。
3.9 語句結束
Java語法中,語句以“;”作為行結束符,例如:
int n = 2;
通常情況下,代碼中每行只寫一句代碼,但是也可以寫多句,例如:
int n = 2; byte b = 10;
但是一般為了代碼結構清楚,只在一行中書寫一句代碼。
有些時候代碼本身比較長,則也可以把一句代碼寫在多行,而代碼語句結束的地方書寫一個“;”即可。
在實際代碼中,一般大括號開始和結束的地方,以及大部分小括號結束的地方都不需要書寫“;”來進行結束。
3.10 注釋
注釋(comment)是對代碼功能和用途的說明。在程序中編寫適當的注釋,將使程序代碼更容易閱讀,增強代碼的可維護性。
注釋在程序編譯時都會被忽略,所以注釋不會增加class文件的大小。
Java語言中注釋的語法有三種:單行注釋、多行注釋和文檔注釋。
3.10.1 單行注釋
單行注釋指只能書寫一行的注釋。單行注釋屬於注釋中最簡單的語法格式,用於對於代碼進行簡單的說明,例如變量功能等。
單行注釋的語法格式為:
//注釋內容
注釋以兩個斜線開始,該行後續的內容都是注釋的內容,注釋內容不能換行。
單行注釋一般書寫在需要說明的代碼的上一行,或者該行代碼的結束處,示例結構如下:
//循環變量
int i = 0;
char sex;//性別
3.10.2 多行注釋
多行注釋指可以書寫任意多行的注釋。多行注釋一般用於說明比較復雜的內容,例如程序邏輯或算法實現原理等。
多行注釋的語法格式為:
/*
注釋內容
*/
注釋以一個斜線和一個星號開始,後續是注釋內容,注釋內容可以書寫任意多行,最後注釋以一個星號和一個斜線結尾。
很多多行注釋在每行以星號開始,這個不是語法必需的。
3.10.3 文檔注釋
文檔注釋指可以被提取出來形成程序文檔的注釋格式,這是Java語言有特色的注釋格式。一般對於程序程序的結構進行說明,例如類、屬性、方法和構造方法進行說明,這些概念在後續將詳細介紹。
文檔注釋的語法格式為:
/**
注釋內容
*/
注釋以一個斜線和兩個星號開始,後續是注釋內容,注釋內容可以書寫任意多行,最後注釋以一個星號和一個斜線結尾。
在後續內容中還將完善該注釋的語法格式。
3.10.4 其它
在規范的代碼中,一般有10%-20%的注釋,也就是每100行代碼中包含10-20行注釋的內容,但是國內很多開發公司都遠遠達不到這個要求。
另外需要特別注意的是,在實際的項目開發中,在修改代碼後,一定要對應的修改注釋的內容,保持代碼和注釋內容的同步。
文章來源:http://blog.csdn.net/Mailbomb/archive/2008/05/17/2453908.aspx