[開發(fā)規(guī)范]編碼排版、注釋規(guī)范.doc

《[開發(fā)規(guī)范]編碼排版、注釋規(guī)范.doc》由會員上傳分享，免費在線閱讀，更多相關內(nèi)容在教育資源-天天文庫。

1、軟件開發(fā)規(guī)《試行版》Version1.0《編程語言開發(fā)規(guī)》2004-6-31排版11-1：程序塊要采用縮進風格編寫，縮進的空格數(shù)為4個。要求：使用編輯器提供的tab設置功能，設置為4；絕對不允許使用4個空格字符11-2：不允許把多個短語句寫在一行中，即一行只寫一條語句。示例：如下例子不符合規(guī)。rect.length=0;rect.width=0;應如下書寫rect.length=0;rect.width=0;11-3：較長的語句（頁寬>80字符）要分成多行書寫，長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進行適當?shù)目s進，使排版整

2、齊，語句可讀。示例：perm_count_msg.head.len=NO7_TO_STAT_PERM_COUNT_LEN+STAT_SIZE_PER_FRAM*sizeof(_UL);act_task_table[frame_id*STAT_TASK_CHECK_NUMBER+index].occupied=stat_poi[index].occupied;act_task_table[taskno].duration_true_or_false=SYS_get_sccp_statistic_state(stat_item);report_or_not_f

3、lag=((taskno

4、結(jié)構的定義及循環(huán)、判斷等語句中的代碼都要采用縮進風格，case語句下的情況處理語句也要遵從語句縮進要求。11-6：程序塊的分界符（如大括號‘{’和‘}’）應各獨占一行并且位于同一列，同時與引用它們的語句左對齊。在函數(shù)體的開始、類的定義、結(jié)構的定義以及if、for、do、while、switch、case語句中的程序都要采用如上的縮進方式。示例：如下例子不符合規(guī)。if(...){...//programcode}voidexample_fun(void){...//programcode}應如下書寫。for(...){...//programcode}if(

5、...){...//programcode}voidexample_fun(void){...//programcode}2注釋12-1：一般情況下，源程序有效注釋量必須在20％以上。說明：注釋的原則是有助于對程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語言必須準確、易懂、簡潔。12-2：文件頭部應進行注釋，注釋必須列出：說明、版本號、生成日期、作者、容、功能、修改日志等.示例：建議所有文件使用該格式；java文件使用javadoc要求的格式/***********************************************

6、**Copyright(C),1988-1999,YOEEInfoTech.Co.,Ltd.Filename://文件名Author:Version:Date://作者、版本及完成日期Description://用于詳細說明此程序文件完成的主要功能，與其他模塊//或函數(shù)的接口，輸出值、取值圍、含義及參數(shù)間的控//制、順序、獨立或依賴等關系Others://其它容的說明History://修改歷史記錄列表，每條修改記錄應包括修改日期、修改//者及修改容簡述#DateAuthorModification12***************************

7、**********************/12-3：函數(shù)頭部應進行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關系（函數(shù)、表）等。示例：建議所有文件使用該格式；java文件使用javadoc要求的格式/*************************************************Description://函數(shù)功能、性能等的描述Pre-Conditions：//前置條件Param://輸入?yún)?shù)說明，包括每個參數(shù)的作用、取值說明及參數(shù)間關系。Return://函數(shù)返回值的說明Others://其它說明********

8、*********************************