1.前言
本文檔主要是為Delphi開發人員提供一個源代碼書寫標准,以及程序和文件的命名標准,使他們在編程時有一致格式可遵循。這樣,每個編程人員編寫的代碼能夠被其他人理解。
--------------------------------------------------------------------------------
2.源程序書寫規范
2.1.通用源代碼格式規則
1). 縮進
縮進就是每級間有兩個空格。不要在源代碼中放置制表符。這是因為,制表符的寬度隨著不同的設置和代碼管理實用程序(打印、文檔及版本控制等)而不同。
通過使用Tools|Environment 菜單,在Environment Options 對話框的General頁上,不要選中Use Tab Character 和Optional Fill 復選框,這樣,制表符就不會被保存。
2). 邊距
邊距設置為80個字符。源代碼一般不會因寫一個單詞而超過邊距,但本規則比較靈活。只要可能,長度超過一行的語句應當用逗號或運算符換行。換行後,應縮進兩個字符。
3). begin...end 語句
begin 語句必須單獨占一行。例如,下面第一行是錯誤的,而第二行正確:
for i:=0 to 10 do begin // 錯, begin 與f o r 在同一行
for i:=0 to 10 do // 對, begin 在另外一行中
begin
本規則的一個特殊情況是,當begin 為else 語句的一部分時,例如:
if some statement = then
begin
. . .
end
else begin
Some Other Statement;
end;
注意:end 語句總單獨一行。當begin 不為else 語句的一部分時,相應的end 語句與begin 語句的縮進量相同。
4).注釋
我們通常使用“{...}”類型的塊注釋,以前的“(*...*)”類型的塊注釋用於臨時注釋掉暫不使用的代碼,從Delphi 2開始支持“//”行注釋,如果決定不在支持Delphi 2.0以下的版本,可以使用“//”注釋。
2.2.Object Pascal語句格式語句書寫規范與用法
1). 括號
在左括號與下一字符之間沒有空格。同樣,右括號與前一字符也沒有空格。下面的例子演示了正確與不正確的空格。
CallProc( Aparameter ); // 錯!
CallProc(Aparameter); // 正確!
不要在語句中包含多余的括號。在源代碼中,括號只有在確實需要時才使用。下面的例子演示了正確與不正確用法:
if (I=42) then // 錯,括號是多余的
if (I=42) or (J=42) then // 正確,必須使用括號
2). 保留字和關鍵字
Object Pascal 語言的保留字和關鍵字總是完全的小寫。下面是Delphi 5保留字列表:
and
array
as
asm
begin
case
class
const
constructor
destructor
dispinterface
div
do
downto
else
end
except
exports
file
finalization
finally
for
function
goto
if
implementation
in
inherited
initialization
inline
interface
is
label
library
mod
nil
not
object
of
or
out
packed
procedure