links下c语言中for的作用是,C语言开发注意事项
C語言開發過程中有很多需要注意的地方,以下內容摘自《華為C語言編程規范總則》
2-2:文件頭部應進行注釋,注釋必須列出:版權說明、版本號、生成日期、作者、內容、 功能、修改日志等。
示例:下面這段頭文件的頭注釋比較標準,當然,并不局限于此格式,但上述信息建議要包
含在內。
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: 用于詳細說明此程序文件完成的主要功能,與其他模塊或函數的接口,輸出
值、取值范圍、含義及參數間的控制、順序、獨立或依賴等關系
Author: 作者
Version: 版本
Date: 完成日期
History: 修 改 歷 史 記 錄 列 表 , 每 條 修 改 記 錄 應 包 括 修 改 日 期 、 修 改
者及修改內容簡述。
*****************************************************************************/
2-3:函數頭部應進行注釋,列出:函數的目的/功能、輸入參數、輸出參數、返回值、調用
關系(函數、表)等。
示例:下面這段函數的注釋比較標準,當然,并不局限于此格式,但上述信息建議要包含在
內。
/*************************************************
Function: // 函數名稱
Description: // 函數功能、性能等的描述
Calls: // 被本函數調用的函數清單
Called By: // 調用本函數的函數清單
Table Accessed: // 被訪問的表(此項僅對于牽扯到數據庫操作的程序)
Table Updated: // 被修改的表(此項僅對于牽扯到數據庫操作的程序)
Input: // 輸入參數說明,包括每個參數的作
// 用、取值說明及參數間關系。
Output: // 對輸出參數的說明。
Return: // 函數返回值的說明
Others: // 其它說明
*************************************************/
2-9:全局變量要有較詳細的注釋,包括對其功能、取值范圍、哪些函數或過程存取它以及
存取時注意事項等的說明。
示例:
/* 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:在代碼的功能、意圖層次上進行注釋,提供有用、額外的信息。
說明:注釋的目的是解釋代碼的目的、功能和采用的方法,提供代碼以外的信息,幫助讀者
理解代碼,防止沒必要的重復注釋信息。
示例:如下注釋意義不大。
/* if receive_flag is TRUE */
if (receive_flag)
而如下的注釋則給出了額外有用的信息。
/* if mtp receive a message from links */
if (receive_flag)
3-8:用正確的反義詞組命名具有互斥意義的變量或相反動作的函數等。
說明:下面是一些在軟件中常用的反義詞組。
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:在同一項目組應明確規定對接口函數參數的合法性檢查應由函數的調用者負責還是由
接口函數本身負責,缺省是由函數調用者負責。
說明:對于模塊間接口函數的參數的合法性檢查這一問題,往往有兩個極端現象,即:要么
是調用者和被調用者對參數均不作合法性檢查,結果就遺漏了合法性檢查這一必要的處理過
程,造成問題隱患;要么就是調用者和被調用者均對參數進行合法性檢查,這種情況雖不會
造成問題,但產生了冗余代碼,降低了效率。
8-15:要時刻注意易混淆的操作符。當編完程序后,應從頭至尾檢查一遍這些操作符,以防
止拼寫錯誤。
說明:形式相近的操作符最容易引起誤用,如 C/C++中的“=”與“==”、“|”與“||”、“&”
與“&&”等,若拼寫錯了,編譯器不一定能夠檢查出來。
示例:如把“&”寫成“&&”,或反之。
9-5:編寫代碼時要注意隨時保存,并定期備份,防止由于斷電、硬盤損壞等原因造成代碼
丟失。
9-9:使用代碼檢查工具(如 C 語言用 PC-Lint)對源程序檢查。
9-10:使用軟件工具(如 LogiSCOPE)進行代碼審查。
11-1:用宏定義表達式時,要使用完備的括號。
11-3:使用宏時,不允許參數發生變化。
示例:如下用法可能導致錯誤。
#define SQUARE( a ) ((a) * (a))
int a = 5;
int b;
b = SQUARE( a++ ); // 結果:a = 7,即執行了兩次增 1。
正確的用法是:
b = SQUARE( a );
a++; // 結果:a = 6,即只執行了一次增 1。
與50位技術專家面對面20年技術見證,附贈技術全景圖總結
以上是生活随笔為你收集整理的links下c语言中for的作用是,C语言开发注意事项的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 字母出现频率c语言,统计字母的使用频率c
- 下一篇: 一个c语言程序什么时候结束,新人求救,写