風格是通用的
C語言和C++語言的編程風格 （Java見下）
第壹章:縮進格式
Tab是8個字符,於是縮進也是8個字符.有很多怪異的風格,他們將縮進格式定義為4個字符(設置為2個字符!)的深度,這就象試圖將PI定義為3壹樣讓人難以接受.
理由是:縮進的大小是為了清楚的定義壹個塊的開始和結束.特別是當妳已經在計算機前面呆了20多個小時了以後,妳會發現壹個大的縮進格式使得妳對程序的理解更容易.
現在,有壹些人說,使用8個字符的縮進使得代碼離右邊很近,在80個字符寬度的終端屏幕上看程序很難受.回答是,但妳的程序有3個以上的縮進的時候,妳就應該修改妳的程序.
總之,8個字符的縮進使得程序易讀,還有壹個附加的好處,就是它能在妳將程序變得嵌套層數太多的時候給妳警告.這個時候,妳應該修改妳的程序.
第二章:大符號的位置
另外壹個C程序編程風格的問題是對大括號的處理.同縮進大小不同,幾乎沒有什麽理由去選擇壹種而不選擇另外壹種風格,但有壹種推薦的風格,它是Kernighan和Ritchie的經典的那本書帶來的,它將開始
的大括號放在壹行的最後,而將結束大括號放在壹行的第壹位,如下所示:
if (x is true) { we do y }
然而,還有壹種特殊的情況:命名函數:開始的括號是放在下壹行的第壹位,如下:
int function(int x) { body of function }
所有非正統的人會非難這種不壹致性,但是,所有思維正常的人明白: (第壹) K&R是___對___的,(第二)如果K&R不對,請參見第壹條. (:-))......另外,函數也是特殊的,不壹定非得壹致.
需要註意的是結束的括號在它所占的那壹行是空的,__除了__它跟隨著同壹條語句的繼續符號.如"while"在do-while循環中,或者"else"在if語句中.如下:
do { body of do-loop } while (condition);
以及
if (x == y) { .. } else if (x > y) { ... } else { .... }
理由: K&R.
另外,註意到這種大括號的放置方法減小了空行的數量,但卻沒有減少可讀性.於是,在屏幕大小受到限制的時候,妳就可以有更多的空行來寫些註釋了.
第三章:命名系統
C是壹種簡潔的語言,那麽,命名也應該是簡潔的.同MODULE-2以及ASCAL語言不同的是,C程序員不使用諸如ThisVariableIsATemporaryCounter之類的命名方式.壹個C語言的程序員會將之命名為"tmp",這很容易書寫,且並不是那麽難以去理解.
然而,當混合類型的名字不得不出現的時候,描述性名字對全局變量來說是必要的了.調用壹個名為"foo"全局的函數是很讓人惱火的.全局變量(只有妳必須使用的時候才使用它) ,就象全局函數壹樣,需要描述性的命名方式.假如妳有壹個函數用來計算活動用戶的數量,妳應該這樣命名--"count_active_users()"--或另外的相近的形式,妳不應命名為"cntusr()".
有壹種稱為Hungarian命名方式,它將函數的類型編碼寫入變量名中,這種方式是腦子有毛病的壹種表現---編譯器知道這個類型而且會去檢查它,而這樣只會迷惑程序員. --知道為什麽Micro$oft為什麽會生產這麽多"臭蟲"程序了把!!.
局部變量的命名應該短小精悍.假如妳有壹個隨機的整數循環計數器,它有可能有"i",如果沒有任何可能使得它能被誤解的話,將其寫作"loop_counter"是效率低下的.同樣的,""tmp"可以是任何臨時數值的函數變量.
如果妳害怕混淆妳的局部變量的名字,還有另外壹個問題,就是稱
function-growth-hormone-imbalancesyndrome.
第四章:函數
函數應該短小而迷人,而且它只作壹件事情.它應只覆蓋壹到兩個屏幕(80*24壹屏),並且只作壹件事情,而且將它做好.(這不就是UNIX的風格嗎,譯者註).
壹個函數的最大長度和函數的復雜程度以及縮進大小成反比.於是,如果妳已經寫了簡單但長度較長的的函數,而且妳已經對不同的情況做了很多很小的事情,寫壹個更長壹點的函數也是無所謂的.
然而,假如妳要寫壹個很復雜的函數,而且妳已經估計到假如壹般人讀這個函數,他可能都不知道這個函數在說些什麽,這個時候,使用具有描述性名字的有幫助的函數.
另外壹個需要考慮的是局部變量的數量.他們不應該超過5-10個,否則妳有可能會出錯.重新考慮這個函數,將他們分割成更小的函數.人的大腦通常可以很容易的記住7件不同的事情,超過這個數量會引起混亂.妳知道妳很聰明,但是妳可能仍想去明白2周以前的做的事情.
第5章:註釋
註釋是壹件很好的事情,但是過多的註釋也是危險的,不要試圖區解釋妳的代碼是註釋如何如何的好:妳應該將代碼寫得更好,而不是花費大量的時間去解釋那些糟糕的代碼.
通常情況下,妳的註釋是說明妳的代碼做些什麽,而不是怎麽做的.而且,要試圖避免將註釋插在壹個函數體裏:假如這個函數確實很復雜,妳需要在其中有部分的註釋,妳應該回到第四章看看.妳可以寫些簡短的註釋來註明或警告那些妳認為特別聰明(或極其醜陋)的部分,但是妳必須要避免過多.取而代之的是,將註釋寫在函數前,告訴別人它做些什麽事情,和可能為什麽要這樣做.
第六章:妳已經深陷其中了.
不要著急.妳有可能已經被告之"GUN emacs"會自動的幫妳處理C的源代碼格式,而且妳已經看到它確實如此,但是,缺省的情況下,它的作用還是不盡如人意(實際上,他們比隨便敲出來的東西還要難看- ainfinite number of monkeys typing into GNU emacs would never make a good program)
於是,妳可以要麽不要使用GUN emacs,要麽讓它使用sanervalules.使用後者,妳需要將如下的語句輸入到妳的.emacs文件中.(defun linux-c-mode() "C mode with adjusted defaults for use with the Linux kernel."(interactive) (c-mode) (c-set-style"K&R") (setq c-basic-offset8))
這會定義壹個M-x Linux-c-mode的命令.當妳hacking壹個模塊的時候,如何妳將-*- linux-c -*-輸入在最開始的兩行,這個模式會自動起作用.而且,妳也許想加入如下
(setq auto-mode-alist (cons '("/usr/src/linux.*/.*.〖ch〗$" . linux-c-mode) auto-mode-alist))
到妳的.emacs文件中,這樣的話,當妳在/usr/src/linux下編輯文件的時候,它會自動切換到linux-c-mode .
但是,假如妳還不能讓emaces去自動處理文件的格式,不要緊張,妳還有壹樣東西: "縮進" .
GNU的縮進格式也很死板,這就是妳為什麽需要加上幾行命令選項.然而,這還不算太壞,因為GNU縮進格式的創造者也記得K&R的權威, (GNU沒有罪,他們僅僅是在這件事情上錯誤的引導了人們) ,妳要做的就只有輸入選項"-kr -i8"(表示"K&R,縮進8個字符).
"縮進"有很多功能,特別是當它建議妳重新格式妳的代碼的時候,妳應該看看幫助.但要記住: "縮進"不是風格很差的程序的萬靈丹.
/portal/Article/itjs/jsjj/cxsj/200511/20051104115145.html
JAVA編程風格簡析
很久以來都在體會著JAVA的風格，現在做壹簡單陳述，希望大家多提寶貴意見。
對於壹種好的編程語言，學習它的編程風格是很重要的。每種語言都有自己的編寫和註釋約定，當然所有語言都建立在最基本的約定之上。編程中最重要的並不是讓代碼按自己希望的方式運行，而是程序中那種自明的編程風格（這對於程序員的益處相信眾多程序員都身有體會）！但這還不夠，程序還應該具有可讀、相對持久和可維護性。可讀性非常重要，因為妳不希望自己以前的作品在之後的閱讀中給自己留下障礙，當然，更重要的是自己的程序能讓其他程序員讀懂並且修改。
下面我把工作中所理解的java風格做壹簡單總結，這是我所理解的好的編程風格和應用中我們應當如何使用java編寫自己的代碼的小Guide。這並不完全，希望大家幫我陸續總結各自的經驗。
壹般性概述
好的編程風格固然重要，但是妳壹定聽說過壹些程序員的個人風格。其實我們完全不必為那些所謂條條框框所累，但是作為原則是我們至少不能打破這些常規。我們應該在保持自己風格的同時盡量的把自己與編程潛原則靠攏。
可讀性很容易達到，比如，讓自己的代碼縮排排列、名字采用描述性但不要過長（短名應僅僅用在非遠程）、特殊名稱比如pi應當被定義為final類型。模塊性是編程需要註意的另壹重點，把代碼劃分到類裏，在類中把功能劃分到方法中，別讓壹個類太大，否則在使用、修改和理解上都會造成不必要的麻煩，方法也壹樣，如果壹個方法長度超過50行，它產生錯誤的概率將接近100％，盡量把大方法劃分為小方法，編程中為避免重復編寫，還應盡量調用JAVA標準類庫。
盡量避免在寫代碼和註釋時使用不同語言，經常見到論壇有朋友詢問諸如在java中調用c、調用php、調用shell之類的問題，其實在編程中，我們應盡量使用壹種語言去完成事情。另外就是不必最優化自己的代碼，應該選擇相對較優的算法就可以了。
類、方法和fields
類應體現出某種物質的基本概念，比如要編程實現“汽車”的組成，那麽所有的汽車都可以用類Car實現。這個類應當包括域描述、屬性描述和car的狀態（color, number of doors, age等）和由car可完成的操作（getColor, setColor等）。為了提高類的可重用性，不要在類中有過多的描述，當然這也會增加錯誤產生的機會。
類名首字母大寫，比如Date, String, Hashtable等 ... ...
類如下定義：(未使用Javadoc做註釋):
public class Car {
/* Instance variables are placed either in the beginning
or at the end of the class */
private int age;
private Color color;
/* The constructor should be placed in the beginning */
public Car(int age, Color color) {
this.age = age;
this.color = color;
}
/* Example method */
public int getAge() {
return age;
}
/* The main method is optional, but looks like this.
If it exists, it is either the first or the last
method in the class */
public static void main(String [] args) {
...
}
}
註意類名和大括號間的空格！
方法
方法壹般定義為public。當然，如果方法僅僅在當前類用到可以定義為private，而如果希望壹個子類沿用這個方法則不同，這時候的方法應定義為protected。
java中的方法定義很有趣，它們壹般小寫字母開頭，如果有兩個字組成，第二個字的首字母則大寫。因此名字的描述性是至關重要的。這使妳不用閱讀整篇代碼來判斷這是壹個什麽方法。在給自己的方法取名時應盡量不要太短或者太長，另壹個需要註意的是大多方法使用動詞（動賓短語）。
例如：
public void eat() {}
public void eatBananas() {}
Selector（選擇器）方法有get前綴，後綴是它們將要get的，比如
public int getBananas() {}
Mutator（存取器）方法則有set前綴，後綴則是他們要set的，比如
public void setBananas(int amount) {}
註意mutators大多無返回值。
方法的參數應當以如下方式給出：
public void aMethod(type parameter1, type parameter2, ... , type parametern) {}
如果參數過長，也可以斷開為幾行，應對齊向下排列如：
public void aMethod(type parameter1, type parameter2,... ,
type parametern, type parameter n+1,... ,
type parameterm, type parameter m+1) {}
另外要註意類的左束括號應在方法的右束括號之後而非下壹行:
public int aMethod() {
int i = 0;
if(i == 0)
System.out.println("success！");
}
為了文件可讀性好，還要註意語句最好寫在同壹行，當然壹行寫不下是可以斷行的，比如行字母超過80。
fields
比如變量，如果不希望它永久有效，應設為private。如果壹個變量在類中不發生任何動作（比如數據結構中的node）則可以設置為public，常量壹般聲明為public。如果不能確定壹個變量到底該聲明為什麽，應暫且聲明為private。
field的名字壹般使用小寫字母，不要使用下橫線或其他特殊字符。 如果變量包含兩個字，那麽第二個字的首字母大寫。比如：
int i, j, k;
Date date;
double myField;
常量壹般全部大寫，也可以包含下橫線：
public static final int MAX_SIZE_OF_DATABASE
fields的名字通常為名詞。較重要的fields更應具備描述性，比如程序中包含壹個遊戲的得分，那可以用score來代表。如果變量變化較頻繁，那使用壹個單壹字符來代表就ok了：
i, j, k 通常代表整數
r, t, u, v, w 通常代表實數
x, y, z 通常是並列出現或代表浮點數
s, s1, s2, 通常代表字符串
c, ch 通常代表字符
f, file 通常代表文件
tmp, temp 通常代表臨時變量
ctr, cnt, cntr 壹般代表計數器(如果i, j, k這些變量已被使用)
dummy, foo, bar 壹般代表啞元變量
args 是main-method的主參數名
縮排與換行
每行長度不得超過80字符。如果需要可以折行時，也應當與上壹行有***同的縮排距離。代碼應如何交錯、如何建立新行、在哪裏建立允許、哪裏不允許都有壹些壹般約定，縮排空格壹般為2個或4個空格。
條件表達式
如果見到如下語法表達式：
if (expr)
statement1;
else
statement2;
代碼行向右錯排兩個空格如上所示。
如果在壹個表達式中有超過壹條的聲明，則需要大括號:
if (expr){
statement1;
statement2;
} else{
statement3;
statement4;
}
有時我們會希望在表達式中使用表達式（比如條件嵌套），這時應註意else表達式，它的位置很容易出錯！如例：
if (expr1) {
statement1;
statement2;
} else if (expr2)
statement3;
else if (expr3) {
statement4;
statement5;
} else {
statement6;
statement7;
}
註意大括號位置！
Loops
while-loop語法如下：
while (expr) {
statement1;
statement2;
}
for-loop語法如下：
for (expr1; expr2; expr3){
statement1;
statement2;
}
註意大括號位置！僅壹條聲明時大括號省略：
while (expr)
statement;
for (expr1; expr2; expr3)
statement;
例如，我們寫壹個procedure寫出1到10這十個數字：
for (i = 1; i <= 10; i++)
System.out.println(i);
try-catch語法形如：
try {
statements;
} catch (ExceptionClass e) {
statements;
}
如果try-catch語句後跟隨finally子句則形如：
try {
statements;
} catch (ExceptionClass e) {
statements;
} finally {
statements;
}
新行
每壹行最好只闡述壹件事情。比如，壹行包含壹個聲明、壹個條件語句、壹個循環等。不論多小，最好不要壹行辦兩件事及以上。例如不要把壹個if表達式或循環語句的主體放置在同壹行，這樣的表達式斷行的易讀性會更高。通常，互相協作的代碼應放在壹起，為保證代碼美觀可讀，我們應將代碼的不同代碼段放置在不同的段落。不過要牢記斷行不要太過分！比如:
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 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;
什麽應當使用JavaDoc做註釋？如何註釋的恰當呢？
可以這樣想，JavaDoc中所作的註釋都可以在類的文檔中看到。所有讀這個類的文檔的讀者都會明白這個類所完成的功能、它包括的方法、如何使用這些方法及方法的返回值。壹些作用域，比如public的變量或常量將會壹目了然。任何不了解這個類內部結構的人都可以輕松的調用它。這便是妳用JavaDoc可以輕松提供的信息。而使用壹般註釋的地方，壹般是給那些可能修改妳的類代碼的程序員，它們壹般描述了類的內部信息和結構。
下面我寫壹下car的類來描述壹個編程風格好的java類應該是怎樣的。當然這僅僅是壹個小例子(apart from selector and mutator methods)，僅僅是在考慮JAVA編程風格上壹個參考而已。
import java.awt.Color;
/**
* This is a class representing cars. A car has certain features, such
* as color, age, number of doors etc and a car can be repainted,
* the tank can be filled etc.
*
* @author Jerry Meng
* @version %I%, %G%
*/
public class Car {
/**
* The maximum size of the tank in litres.
*/
private static final double TANK_SIZE = 100.0;
/**
* The color of the car.
*/
private Color color;
/**
* The age of the car.
*/
private int age;
/**
* The number of doors of the car.
*/
private int doors;
/**
* The amount of gasoline in the tank.
*/
private double gasoline;
/**
* Class constructor, which constructs a brand new, black car with
* five doors and a full tank.
*/
public Car() {
this(Color.black, 0, 5, TANK_SIZE);
}
/**
* Class constructor specifying the color, age, number of doors
* and litres of gasoline
*
* @param color The color of the car
* @param age The age of the car
* @param doors The number of doors
* @param km Kilometres driven
* @param gasoline The litres of gasoline
*/
public Car(Color color, int age, int doors, double gasoline) {
this.color = color;
this.age = age;
this.doors = doors;
this.gasoline = gasoline;
}
/**
* Returns the color of the car
*/
public Color getColor() {
return color;
}
/**
* Repaints the car (i.e. changes its color)
*/
public void setColor(Color color) {
this.color = color;
}
/**
* Returns the age of the car
*/
public int getAge() {
return age;
}
/**
* Returns the number of doors of the car
*/
public int getDoors() {
return doors;
}
/**
* Returns the amount of gasoline in the tank
*/
public double getGasoline() {
return gasoline;
}
/**
* Fills the tank. The amount of gasoline cannot exceed
* the size of the tank. In that case, the tank will be
* filled to the maximum and the rest will run out in
* the sand.
*
* @param gas The amount of gasoline to put in the tank
*/
public void setGasoline(double gas) {
if(gasoline + gas <= TANK_SIZE)
gasoline+=gas;
else
gasoline = TANK_SIZE;
}
}
/jh/26/511939.html
/bookfiles/170/1001707562.shtml