本文目錄一覽:
c語言代碼編寫的格式?
C語言 程序代碼編寫規範
(初級程序員 討論版)
前言
一個好的程序編寫規範是編寫高質量程序的保證。清晰、規範的源程序不僅僅是方便閱讀,更重要的是能夠便於檢查錯誤,提高調試效率,從而最終保證軟件的質量和可維護性。
說明
l 本文檔主要適用於剛剛開始接觸編程的初學者。
l 對於具有一定工程項目開發經驗的程序員,建議學習C語言程序代碼編寫規範—高級版。
目錄
1 代碼書寫規範
2 注釋書寫規範
3 命名規範
4 其它一些小技巧和要求
1 代碼書寫規範
1.1函數定義
花括號: { }
每個函數的定義和說明應該從第1列開始書寫。函數名(包括參數表)和函數體的花括號應該各佔一行。在函數體結尾的括號後面可以加上注釋,注釋中應該包括函數名,這樣比較方便進行括號配對檢查,也可以清晰地看出來函數是否結束。
範例1:函數的聲明
void matMyFunction(int n)
{
……
} /* matMyFunction*/
1.2空格與空行的使用
要加空格的場合
l 在逗號後面和語句中間的分號後面加空格,如:
int i, j, k;
for (i = 0; i n; i++)
result = func(a, b, c);
l 在二目運算符的兩邊各留一個空格,如
a b a = b i = 0
l 關鍵字兩側,如if () …, 不要寫成if() …
l 類型與指針說明符之間一定要加空格:
char *szName;
不加空格的場合
l 在結構成員引用符號.和-左右兩加不加空格:
pStud-szName, Student.nID
l 不在行尾添加空格或Tab
l 函數名與左括號之間不加空格:
func(…)
l 指針說明符號*與變量名間不要加空格:
int *pInt; 不要寫成: int * pInt;
l 複合運算符中間不能加空格,否則會產生語法錯誤,如:
a + = b a = b 都是錯誤的
空行與換行
l 函數的變量說明與執行語句之間加上空行;
l 每個函數內的主要功能塊之間加空行表示區隔;
l 不要在一行中寫多條語句.
範例2:空行與換行
int main()
{
int i, j, nSum = 0; //變量說明
for (i = 0; i 10; i++) //執行代碼
{
for (j = 0; j 10; j++)
{
nSum += i;
}
}
}
1.3縮進的設置
根據語句間的層次關係採用縮進格式書寫程序,每進一層,往後縮進一層
有兩種縮進方式:1,使用Tab鍵;2,採用4個空格。
整個文件內部應該統一,不要混用Tab鍵和4個空格,因為不同的編輯器對Tab鍵的處理方法不同。
1.4折行的使用
· 每行的長度不要超過80個字符,當程序行太長時,應該分行書寫。
· 當需要把一個程序行的內容分成幾行寫時,操作符號應該放在行末。
· 分行時應該按照自然的邏輯關係進行,例如:不要把一個簡單的邏輯判斷寫在兩行上。
· 分行後的縮進應該按照程序的邏輯關係進行對齊。例如:參數表折行後,下面的行應該在參數表左括號的下方。
範例2:折行的格式
dwNewShape = matAffineTransform(coords, translation,
rotation);
if (((new_shape.x left_border)
(new_shape.x right_border))
((new_shape.y bottom_border)
(new_shape.y top_border)))
{
draw(new_shape);
}
1.5嵌套語句(語句塊)的格式
對於嵌套式的語句–即語句塊(如,if、while、for、switch等)應該包括在花括號中。花括號的左括號應該單獨佔一行,並與關鍵字對齊。建議即使語句塊中只有一條語句,也應該使用花括號包括,這樣可以使程序結構更清晰,也可以避免出錯。建議對比較長的塊,在末尾的花括號後加上注釋以表明該語言塊結束。
範例3:嵌套語句格式
if (value max)
{
if (value != 0)
{
func(value);
}
}
} else {
error(“The value is too big.”);
} /* if (value max) */
2 注釋書寫規範
注釋必須做到清晰,準確地描述內容。對於程序中複雜的部分必須有注釋加以說明。注釋量要適中,過多或過少都易導致閱讀困難。
2.1注釋風格
· C語言中使用一組(/* … */)作為注釋界定符。
· 注釋內容盡量用英語方式表述。
· 注釋的基本樣式參考範例4。
· 注釋應該出現在要說明的內容之前,而不應該出現在其後。
· 除了說明變量的用途和語言塊末尾使用的注釋,盡量不使用行末的注釋方式。
範例4:幾種注釋樣式
/*
* ************************************************
* 強調注釋
* ************************************************
*/
/*
* 塊注釋
*/
/* 單行注釋 */
//單行注釋
int i; /*行末注釋*/
2.2何時需要注釋
· 如果變量的名字不能完全說明其用途,應該使用注釋加以說明。
· 如果為了提高性能而使某些代碼變得難懂,應該使用注釋加以說明。
· 對於一個比較長的程序段落,應該加註釋予以說明。如果設計文檔中有流程圖,則程序中對應的位置應該加註釋予以說明。
· 如果程序中使用了某個複雜的算法,建議註明其出處。
· 如果在調試中發現某段落容易出現錯誤,應該註明。
3 命名規範
3.1常量、變量命名
l 符號常量的命名用大寫字母表示。如:
#define LENGTH 10
l 如果符號常量由多個單詞構成,兩個不同的單詞之間可以用下劃線連接。如:
#define MAX_LEN 50
變量命名的基本原則:
l 可以選擇有意義的英文(小寫字母)組成變量名,使人看到該變量就能大致清楚其含義。
l 不要使用人名、地名和漢語拼音。
l 如果使用縮寫,應該使用那些約定俗成的,而不是自己編造的。
l 多個單詞組成的變量名,除第一個單詞外的其他單詞首字母應該大寫。如:
dwUserInputValue。
3.2函數命名
函數命名原則與變量命名原則基本相同。對於初學者,函數命名可以採用“FunctionName”的形式。
4 其它一些小技巧和要求
l 函數一般情況下應該少於100行
l 函數定義一定要包含返回類型,沒有返回類型加void
l 寫比較表達式時,將常量放在左邊
10 == n
NULL != pInt
l 指針變量總是要初始或重置為NULL
l 使用{}包含複合語句,即使是只有一行,如:
if (1 == a)
{
x = 5;
}
什麼是c語言偽代碼
所謂偽代碼,就是那些用來表示算法的文字段落。
你想寫一個程序,不可能就直接寫代碼,你得先寫思路,用來暫時記錄你思路的文字符號一般用簡單的詞語來。
比如:
初始化 字符串 A;
輸入字符串 A;
如果 檢測字符串 A 成功 就
打開文件(A);
否則 回到輸入字符串;
偽代碼根據個人習慣而不同,主要的是用來表達你想好了的思路。
用C語言描述的偽代碼怎麼看,怎麼寫?
偽代碼主要是為了方便各種語言來實現,像你這裡的用C實現就是:
struct Node{
int number;
struct Node *Next;
};
ElementType :元素類型
Element:元素名
Position :位置,定義Next指針
QQ已私信給你~
C語言中的“偽碼”到底是啥???
就是偽代碼,也就是就是用常規語言或文字符號(即非編程語言寫的)代碼算法,叫偽代碼
只是為了直觀的表達出算法,才用偽代碼,還有相應的偽代碼語言等,這些代碼無法運行,只有通過按照偽代碼所表達的算法或操作,編好程序,才能運行. 舉例,我要表達c語言中的i++操作,我可以些成”i自加1″,當然一看就知道i自加1是機器讀不懂的這種用人能看懂,機器看不懂的語言來描述程序邏輯和結構的代碼就是偽代碼了……
C語言的書寫規則主要有哪些呢?
從書寫清晰,便於閱讀,理解,維護的角度出發,在書寫程序時
應遵循以下規則:
1.一個說明或一個語句佔一行。
2.用{}
括起來的部分,通常表示了程序的某一層次結構。{}一般與該結構語句的第一個字母對齊,並單獨佔一行。
3.低一層次的語句或說明可比高一層次的語句或說明縮進若干格後書寫。以便看起來更加清晰,增加程序的可讀性。在編程時應力求遵循這些規則,以養成良好的編程風格。
有空格的地方就可以換行!
if(
a
==
b
e
==
c
){}
和
if(
a
==
b
e
==
c
)
{
}
是完全一樣的
偽代碼怎麼寫
偽代碼(Pseudocode)是一種算法描述語言。使用偽代碼的目的是為了使被描述的算法可以容易地以任何一種編程語言(Pascal,C,Java,etc)實現。因此,偽代碼必須結構清晰、代碼簡單、可讀性好,並且類似自然語言。 介於自然語言與編程語言之間。 它以編程語言的書寫形式指明算法的職能。相比於程序語言(例如Java, C++,C, Dephi 等等)它更類似自然語言。它是半角式化、不標準的語言。我們可以將整個算法運行過程的結構用接近自然語言的形式(這裡,你可以使用任何一種你熟悉的文字,中文,英文 等等,關鍵是你把你程序的意思表達出來)描述出來. 使用偽代碼, 可以幫助我們更好的表述算法, 不用拘泥於具體的實現. 人們在用不同的編程語言實現同一個算法時意識到,他們的實現(注意:這裡是實現,不是功能)很不同。尤其是對於那些熟練於不同編程語言的程序員要理解一個(用其他編程語言編寫的程序的)功能時可能很難,因為程序語言的形式限制了程序員對程序關鍵部分的理解。這樣偽代碼就應運而生了。 當考慮算法功能(而不是其語言實現)時,偽代碼常常得到應用。計算機科學在教學中通常使用虛擬碼,以使得所有的程序員都能理解。 綜上,簡單的說,讓人便於理解的代碼。不依賴於語言的,用來表示程序執行過程,而不一定能編譯運行的代碼。在數據結構講算法的時候用的很多。
原創文章,作者:小藍,如若轉載,請註明出處:https://www.506064.com/zh-hant/n/155333.html