【正文】 全局變量，則也要說明出口參數(shù)：對出口參數(shù)作簡要的說明，改變了全局變量，則也要說明返回值：對函數(shù)的返回值說明其類型和作用程序設計的若干規(guī)定這里例舉了C語言和匯編語言的規(guī)定，其他編程語言應參照這些規(guī)定編寫C語言見附錄六匯編語言見附錄六附錄六：程 序 設 計 若 干 規(guī) 定引言本文檔描述了項目開發(fā)中的編程標準，其目的是提供一個編程的嚴格規(guī)則，使得程序有統(tǒng)一的風格，以便于理解和維護，項目主要由C語言和匯編語言編寫.C語言產(chǎn)生新代碼圖D1描述了產(chǎn)生C語言新代碼的格式，在寫新代碼之前，然后編輯新文件以提供下列信息.目的提供一個關于程序的簡要描述.版本狀態(tài)給出當日的日期，程序員姓名，創(chuàng)建或修改.輸入列出及描述所有該程序將輸入的變量，描述應簡要而完全，有必要要描述一個組中不同的元素，或者一個詞的字節(jié)或位，如果沒有輸入變量,則鍵入none.輸出列出及描述所有該函數(shù)的輸出變量，同時描述副作用，如果有的話.限制簡要說明程序的限制，例如數(shù)組長度，算法等等，同時給出對未來版本的建議，如果沒有限制，給出“none”錯誤信息描述出錯信息或在出錯時變量的置值，如果沒有的話給出“none”.方法簡單描述程序中所有調用的算法及方法，如果方法很明顯，則刪去這一項，如果應用了復雜的算法或方程式，請給出解釋及參考.外部變量描述僅列出及描述那些一般不為人所知的變量，如果該函數(shù)不用任何外部變量，給出“none”.局部、靜態(tài)、寄存器變量描述列出及描述局部，靜態(tài)寄存器變量，如果一個變量的用途可從其它變量名中明顯地看到，則不必給出解釋，變量名按字典順序列出. /*********************************************************** * 本程序屬于XXXXXXXXX(公司名).作為商品機密 * * 版權所有,未經(jīng)許可不得公布或使用. * ************************************************************. 目的 函數(shù)的功能描述. 版本狀態(tài) 11790(程序員姓名)新代碼. 輸入 列出所有輸入變量和解釋. 輸出 列出所有輸出變量／參數(shù)／返回值及解釋. 限制 給出使用的算法和處理方法. 錯誤信息 描述錯誤信息. 方法 該函數(shù)中用的算法和處理方法. 函數(shù)調用 列出調用的函數(shù). 外部變量 描述所有使用的外部變量. 局部變量 描述局部變量. */圖 D1 C標準格式(in “”)改舊代碼在函數(shù)頭上的所有必要的信息必須修改, 版本狀態(tài)必須包含版本日期, 程序員姓名, 以及版本的簡要描述, 這種描述必須規(guī)格化, 而且要包含足夠的信息, 以便于對這些修改進行回溯. 版本狀態(tài)列出的順序必須使得最新的版本列在最上邊. 所有其它的信息包括輸入、輸出、限制、以及函數(shù)調用等等, 必須與最新的版本保持一致.編程常規(guī)下面說明了C語言指令中的標準結構:程序設計風格 通過空格和空行, 使程序有層次感, 便于閱讀. 提倡使用C++的語法和程序結構. 所有代碼必須是小寫字符, 以下的例外: 1。在編譯或連接器中要求大寫的標識符或庫函數(shù)名. 3。 在用malloc或calloc申請空間之后, 必須牢記在不需要它們的時候調用free釋放空間以便于將來使用空間.類型說明 類型說明的順序是由短到長: char short long float double 盡量不使用int, 用short或long取代, 以免不同硬件環(huán)境的影響. .變量名變量名的長度沒有限制. 但各個變量的前31個字符必須唯一.(各系統(tǒng)的狀態(tài)會有變化,盡可能在開始時區(qū)分變量名). 建議用英文語句的一般風格命名變量名, 英文單詞的首字母大寫，后面的字母小寫。比如：class 不是C編譯器的關鍵字，但是C++的關鍵字，在用C編譯器開發(fā)的系統(tǒng)中，不能采用class作為變量名，否則將影響移植性。外部變量 外部變量必須在函數(shù)中以extern語句說明 . 如果外部變量是數(shù)組,在外部說明中,第一維必須為空. 如果不同類型的變量要組在一起,用結構取代數(shù)組. 將外部變量說明成static類, 如果它們在一個文件中共享而不被其它文件訪問.常量 對公共使用的常量,.for 循環(huán)對于數(shù)組的處理,循環(huán)的結束用取代=.例: int a[9]。i9。 ...。 long *plong。 (1) plong=(long *)(buf+2)。則在(1)中plong=8,(2)中plong=2。 /*... ...*/匯編語言產(chǎn)生新模塊代碼圖D2描述了產(chǎn)生匯編語言新模塊代碼的格式, 在寫新代碼之前,.目的提供一個關于程序模塊的簡要描述.版本狀態(tài)給出當日的日期,程序員姓名，版本號。版本狀態(tài)和歷史給出當日的日期,程序員姓名.入口參數(shù)列出及描述所有該子過程將輸入的變量和寄存器，描述應簡要而完全, 有必要描述一個組中不同的元素, 或者一個詞的字節(jié)或位. 如果沒有輸入變量,則鍵入“none”.出口參數(shù)列出及描述所有該子過程的輸出變量和寄存器, 同時描述對全局變量的影響和被破壞的寄存器, 如果有的話. 同時還要描述出錯信息或在出錯時變量的值, 如果沒有的話給出“none”.默認的段寄存器和段名用ASSUME指出在該子過程中，默認的段寄存器和段名的關系。%圖 D3 標準格式(in “”)修改舊代碼在過程頭上的所有必要的信息必須修改, 版本狀態(tài)必須包含版本日期, 程序員姓名, 以及版本的簡要描述, 這種描述必須規(guī)格化, 而且要包含足夠的信息, 以便于對這些修改進行回溯. 版本狀態(tài)列出的順序必須使得最新的版本列在最上邊. 所有其它的信息包括輸入、輸出、限制、以及過程調用等等, 必須與最新的版本保持一致.編程常規(guī)下面說明了匯編語言指令中的標準結構:程序設計風格 應該遵照 MIRCOSOFT MASM ~ ASMBLE ~。對于外部(公共)子過程名,在第一個字符之前加_.變量名變量名的長度沒有限制. 但各個變量的前31個字符必須唯一.(各系統(tǒng)的狀態(tài)會有變化, 盡可能在開始時加以區(qū)分).建議用英文語句的一般風格命名變量名. 英文單詞的首字母大寫，后面的字母小寫。常量對公共使用的常量, .標號 所有標號應在第一列開始. 標號名稱由子過程名稱的簡寫(用大寫字母)加下劃線加有具體含義的單詞構成。xxxxx 在語句后的注釋必須與語句在同一行: statement 。..._ ... 如果注釋太長, 超出一行,應將其按如下格式放在語句之前: 。... 。... 每一個變量都應以注釋, 對其用途、含義、可能的取值加以說明。... ... 帶注釋的指令不得少于整個程序指令數(shù)的三分之一. 在同一個文件中, 盡量將注釋對齊. 每實現(xiàn)一相對完整邏輯功能的一段指令前必須用注釋給出該功能的描述, 且各個該類型指令段間用空行或注釋行分隔.35 /