C語言開發(fā)過程中有很多需要注意的地方，以下內(nèi)容摘自《華為C語言編程規(guī)范總則》

2-2：文件頭部應(yīng)進(jìn)行注釋，注釋必須列出：版權(quán)說明、版本號、生成日期、作者、內(nèi)容、 功能、修改日志等。

示例：下面這段頭文件的頭注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包

含在內(nèi)。

Generated by Foxit PDF Creator ? Foxit Software

http://www.foxitsoftware.com For evaluation only.

- 4 -

/*****************************************************************************

Copyright: 1988-1999, Huawei Tech. Co., Ltd.

File name: 文件名

Description: 用于詳細(xì)說明此程序文件完成的主要功能，與其他模塊或函數(shù)的接口，輸出

值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系

Author: 作者

Version: 版本

Date: 完成日期

History: 修 改 歷 史 記 錄 列 表 ， 每 條 修 改 記 錄 應(yīng) 包 括 修 改 日 期 、 修 改

者及修改內(nèi)容簡述。

*****************************************************************************/

2-3：函數(shù)頭部應(yīng)進(jìn)行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用

關(guān)系(函數(shù)、表)等。

示例：下面這段函數(shù)的注釋比較標(biāo)準(zhǔn)，當(dāng)然，并不局限于此格式，但上述信息建議要包含在

內(nèi)。

/*************************************************

Function: // 函數(shù)名稱

Description: // 函數(shù)功能、性能等的描述

Calls: // 被本函數(shù)調(diào)用的函數(shù)清單

Called By: // 調(diào)用本函數(shù)的函數(shù)清單

Table Accessed: // 被訪問的表(此項(xiàng)僅對于牽扯到數(shù)據(jù)庫操作的程序)

Table Updated: // 被修改的表(此項(xiàng)僅對于牽扯到數(shù)據(jù)庫操作的程序)

Input: // 輸入?yún)?shù)說明，包括每個(gè)參數(shù)的作

// 用、取值說明及參數(shù)間關(guān)系。

Output: // 對輸出參數(shù)的說明。

Return: // 函數(shù)返回值的說明

Others: // 其它說明

*************************************************/

2-9：全局變量要有較詳細(xì)的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及

存取時(shí)注意事項(xiàng)等的說明。

示例：

/* The ErrorCode when SCCP translate */

/* Global Title failure, as follows */ // 變量作用、含義

/* 0 － SUCCESS 1 － GT Table error */

/* 2 － GT error Others － no use */ // 變量取值范圍

/* only function SCCPTranslate() in */

/* this modual can modify it, and other */

/* module can visit it through call */

/* the function GetGTTransErrorCode() */ // 使用方法

BYTE g_GTTranErrorCode;

2-13：在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息。

說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者

理解代碼，防止沒必要的重復(fù)注釋信息。

示例：如下注釋意義不大。

/* if receive_flag is TRUE */

if (receive_flag)

而如下的注釋則給出了額外有用的信息。

/* if mtp receive a message from links */

if (receive_flag)

3-8：用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)等。

說明：下面是一些在軟件中常用的反義詞組。

add / remove begin / end create / destroy

insert / delete first / last get / release

increment / decrement put / get

add / delete lock / unlock open / close

min / max old / new start / stop

next / previous source / target show / hide

send / receive source / destination

cut / paste up / down

示例：

int min_sum;

int max_sum;

int add_user( BYTE *user_name );

int delete_user( BYTE *user_name );

6-5：在同一項(xiàng)目組應(yīng)明確規(guī)定對接口函數(shù)參數(shù)的合法性檢查應(yīng)由函數(shù)的調(diào)用者負(fù)責(zé)還是由

接口函數(shù)本身負(fù)責(zé)，缺省是由函數(shù)調(diào)用者負(fù)責(zé)。

說明：對于模塊間接口函數(shù)的參數(shù)的合法性檢查這一問題，往往有兩個(gè)極端現(xiàn)象，即：要么

是調(diào)用者和被調(diào)用者對參數(shù)均不作合法性檢查，結(jié)果就遺漏了合法性檢查這一必要的處理過

程，造成問題隱患；要么就是調(diào)用者和被調(diào)用者均對參數(shù)進(jìn)行合法性檢查，這種情況雖不會(huì)

造成問題，但產(chǎn)生了冗余代碼，降低了效率。

8-15：要時(shí)刻注意易混淆的操作符。當(dāng)編完程序后，應(yīng)從頭至尾檢查一遍這些操作符，以防

止拼寫錯(cuò)誤。

說明：形式相近的操作符最容易引起誤用，如 C/C++中的“=”與“==”、“|”與“||”、“&”

與“&&”等，若拼寫錯(cuò)了，編譯器不一定能夠檢查出來。

示例：如把“&”寫成“&&”，或反之。

9-5：編寫代碼時(shí)要注意隨時(shí)保存，并定期備份，防止由于斷電、硬盤損壞等原因造成代碼

丟失。

9-9：使用代碼檢查工具(如 C 語言用 PC-Lint)對源程序檢查。

9-10:使用軟件工具(如 LogiSCOPE)進(jìn)行代碼審查。

11-1：用宏定義表達(dá)式時(shí)，要使用完備的括號。

11-3:使用宏時(shí)，不允許參數(shù)發(fā)生變化。

示例：如下用法可能導(dǎo)致錯(cuò)誤。

#define SQUARE( a ) ((a) * (a))

int a = 5;

int b;

b = SQUARE( a++ ); // 結(jié)果：a = 7，即執(zhí)行了兩次增 1。

正確的用法是：

b = SQUARE( a );

a++; // 結(jié)果：a = 6，即只執(zhí)行了一次增 1。

與50位技術(shù)專家面對面20年技術(shù)見證，附贈(zèng)技術(shù)全景圖

總結(jié)

以上是生活随笔為你收集整理的links下c语言中for的作用是,C语言开发注意事项的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。