資源描述：
《源程序文檔化.ppt》由會員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在應(yīng)用文檔-天天文庫。
1、軟件工程研討源程序文檔化第六組組員：12122208陳帥12123298馬敏12123249雷晴12123256邱可藝2014.12.16變量、常量和函數(shù)的命名規(guī)范變量名所有字母小寫，單詞之間用下劃線(_)分開，類成員變量以下劃線結(jié)束。普通變量命名(CommonVariableNames)比如：類數(shù)據(jù)組成變量命名(ClassDataMembers)數(shù)據(jù)成員（又叫實(shí)例變量或者成員變量）的命名與普通變量一樣，全部字母小寫，可選的下劃線分隔符，但應(yīng)該以下劃線結(jié)束。stringtable_name_;//可以－以下劃線結(jié)
2、束stringtablename_;//可以變量命名(VariableNames)stringtable_name;//可以－使用下劃線stringtablename;//可以－全部字母小寫stringtableName;//糟糕－大小寫混合結(jié)構(gòu)體成員變量命名(StructVariables)結(jié)構(gòu)體成員變量和普通變量命名規(guī)則一致，且不像類成員變量以下劃線結(jié)束。structUrlTableProperties{stringname;intnum_entries;}全局變量命名(GlobalVariables)全局變
3、量的使用較為罕見，但當(dāng)用到時，考慮以前綴g_開頭或標(biāo)以其他記號，以便與局部變量區(qū)分。常量命名(ConstantNames)K后跟混合大小寫的名稱：kDaysInAWeek。所有編譯時常量，不管是被聲明為局部、全局還是作為類的成員，都應(yīng)該遵守與其他變量命名有輕微差別的命名約定：k后跟單詞首字母大寫的名稱：constintkDaysInAWeek=7;函數(shù)命名(FunctionNames)正規(guī)函數(shù)名應(yīng)該以大寫字母開頭，單詞首字母大寫，不使用下劃線。如果函數(shù)可能因錯誤而崩潰，應(yīng)該在函數(shù)名后加上OrDie。這僅適用于那些
4、被產(chǎn)品代碼調(diào)用或者正常操作有可能引起錯誤的函數(shù)。AddTableEntry()DeleteUrl()OpenFileOrDie()訪問器和修改器(AccessorsandMutators)訪問器和修改器（get和set函數(shù)）應(yīng)該與它們關(guān)聯(lián)的變量名匹配。下面顯示了一個類的部分摘錄，它有一個實(shí)例變量num_entriesclassMyClass{public:...intnum_entries()const{returnnum_entries;}voidset_num_entries(intnum_entries){
5、num_entries=num_entries;}private:intnum_entries_;};你也可以使用小寫字母和下劃線來命名非常短小的內(nèi)聯(lián)函數(shù)。比如，如果一個函數(shù)的調(diào)用開銷很小，在循環(huán)調(diào)用時，沒必要緩存其值，這時，小寫字母命名是允許的。對文件、類、函數(shù)、變量和邏輯功能段進(jìn)行注釋的規(guī)范文件注釋(FileComments)每個文件都應(yīng)該提供版權(quán)信息，然后是文件內(nèi)容的綜合性描述。合法公告和作者信息行(LegalNoticeandAuthorLine)每個文件都應(yīng)依次包括以下條目，1、版權(quán)聲明(比如Copyr
6、ight2008GoogleInc.)；2、一個許可引用。選擇適合你項(xiàng)目使用的許可引用（比如Apache2.0、BSD、LGPL、GPL）3、作者信息行說明文件原始作者如果你對原始作者的文件做了實(shí)質(zhì)性修改，可以在作者信息行加上你的名字。當(dāng)其他開發(fā)者有問題時，這樣可以方便他們正確地聯(lián)系到修改者。文件內(nèi)容注釋(FileContents)每個文件都應(yīng)該在其版權(quán)信息及作者信息后面和內(nèi)容前面有一個內(nèi)容描述性的注釋。通常，頭文件描述它所聲明的類的目的及用法。而源文件則應(yīng)該包含更多有關(guān)實(shí)現(xiàn)和技巧性算法的討論信息。但如果你覺得這
7、些信息對于頭文件的閱讀者更有用，可以將其放在頭文件中，但在源文件中應(yīng)該注明其文檔在頭文件中。不要在頭文件和源文件中重復(fù)注釋，這樣容易造成歧義。類注釋(ClassComments)每個類定義都應(yīng)該伴隨有說明其目的和用法的注釋。//遍歷GargantuanTable的內(nèi)容。用法示例：//GargantuanTableIterator*iter=table->NewIterator();//for(iter->seek(“foo”);!iter->done();iter->next()){//process(iter-
8、>key(),iter->value();//}//deleteiter;ClassGargantuanTableIterator{...如果你在文件開始就已對類進(jìn)行了詳細(xì)描述，可以在類實(shí)現(xiàn)部分簡單地聲明“參見文件開始注釋部分的完整描述”，但注意，這里還是要添加少量注釋。函數(shù)注釋(FunctionComments)函數(shù)聲明部分的注釋描述函數(shù)的用法，實(shí)現(xiàn)部分的注釋描述函數(shù)實(shí)
