地址： 上海市靜安區(qū)共和新路4718弄10號(hào)樓2樓
熱線(xiàn)：400-166-3538
電話(huà)：19301461038
郵箱：sales@shyuanzhen.cn
1. 對(duì)不同級(jí)別的代碼進(jìn)行注釋
對(duì)于不同級(jí)別的代碼塊，要使用統(tǒng)一的方法來(lái)進(jìn)行注釋。例如：
對(duì)于每一個(gè)類(lèi)，需要包含一段簡(jiǎn)明扼要的描述，作者和上一次修改的時(shí)間
對(duì)于每一個(gè)方法，需要包含這個(gè)方法的用途，功能，參數(shù)以及返回結(jié)果
當(dāng)你在一個(gè)團(tuán)隊(duì)里面的時(shí)候，采用一套注釋的標(biāo)準(zhǔn)是非常重要的。當(dāng)然，使用一種大家都認(rèn)可的注釋約定和工具(例如C#的XML注釋和Java的Javadoc)在一定程度上能推動(dòng)這項(xiàng)任務(wù)。
2. 使用段落注釋
首先把代碼塊分解成多個(gè)“段落”，每一個(gè)段落都執(zhí)行單一的任務(wù);然后在每一個(gè)“段落”開(kāi)始之前添加注釋?zhuān)嬖V閱讀代碼的人接下來(lái)的這段代碼是干什么用的
3. 對(duì)齊注釋行
對(duì)于那些在行末寫(xiě)有注釋的代碼，應(yīng)該對(duì)齊注釋行來(lái)使得方便閱讀
有些開(kāi)發(fā)人員使用tab來(lái)對(duì)齊注釋?zhuān)硗庖恍┤藭?huì)用空格來(lái)對(duì)齊。由于tab在不同的編輯器和集成開(kāi)發(fā)環(huán)境中會(huì)有所不同，所以最佳的方法是使用空格來(lái)對(duì)齊注釋行。
4. 不要侮辱閱讀者的智慧
要避免沒(méi)用的注釋?zhuān)?/span>
這不單把時(shí)間浪費(fèi)在寫(xiě)沒(méi)用的注釋上面，同時(shí)也在分散讀者的注意力。
5. 要有禮貌
應(yīng)當(dāng)避免沒(méi)有禮貌的注釋?zhuān)纭耙⒁庖恍┯薮赖挠脩?hù)會(huì)輸入一個(gè)負(fù)數(shù)”，或者“修正由菜鳥(niǎo)工程師寫(xiě)的愚蠢得可憐的代碼而導(dǎo)致的副作用”。這樣的注釋對(duì)于代碼的寫(xiě)注釋的人來(lái)說(shuō)并沒(méi)有任何好處，同時(shí)你永遠(yuǎn)都不會(huì)知道將來(lái)這些注釋會(huì)被誰(shuí)來(lái)閱讀，你的老板，一個(gè)客戶(hù)或者是剛才被你數(shù)落的愚蠢得可憐的工程師。
6. 直截了當(dāng)
不要在注釋里面寫(xiě)過(guò)多的廢話(huà)。避免在注釋里面賣(mài)弄ASCII藝術(shù)，寫(xiě)笑話(huà)，作詩(shī)和過(guò)于冗長(zhǎng)。簡(jiǎn)而言之就是保持注釋的簡(jiǎn)單和直接。
7. 使用統(tǒng)一的風(fēng)格
有些人覺(jué)得注釋?xiě)?yīng)該讓非程序員也能看懂。另外一些人覺(jué)得注釋需要面對(duì)的讀者只是程序員。無(wú)論如何，正如Successful Strategies for Commenting Code中所說(shuō)的，最重要的是注釋的風(fēng)格需要統(tǒng)一，并且總是面向相同的讀者。就自己而論，我懷疑非程序員是否會(huì)去讀代碼，所以我覺(jué)得注釋?xiě)?yīng)該面向程序員來(lái)寫(xiě)。
? ? ? ? | 公司名稱(chēng)：上海緣震網(wǎng)絡(luò)科技有限公司 開(kāi)戶(hù)銀行：中國(guó)工商銀行上海市彭浦支行 銀行賬號(hào)：1001 2508 0930 0206 455 |
總部：上海市奉賢區(qū)金海公路6055號(hào)29號(hào)3樓 分部：上海市靜安區(qū)共和新路4718弄10號(hào)樓2樓 商務(wù)官網(wǎng)：www.centos9.com 新官網(wǎng)：www.shyuanzhen.com 案例庫(kù)：www.shyuanzhen.cc 彥蓁科技：www.shyanzhen.cn | 緣震網(wǎng)絡(luò)成立于 2014 年，公司主要經(jīng)營(yíng)全案策劃，高端品質(zhì)網(wǎng)站建設(shè)、多媒體視頻宣傳片制作、微信公眾號(hào)開(kāi)發(fā)、微信小程序開(kāi)發(fā)、商城定制、SEO優(yōu)化、電商托管、空間托管、網(wǎng)站維護(hù)、應(yīng)用軟件開(kāi)發(fā)、手機(jī)端APP開(kāi)發(fā)、等為客戶(hù)提供一條龍網(wǎng)絡(luò)運(yùn)營(yíng)解決方案的的技術(shù)型企業(yè)。我們?cè)谌肆Y源、業(yè)務(wù)范圍、設(shè)計(jì)、技術(shù)、服務(wù)、信譽(yù)度、規(guī)范管理及企業(yè)文化等諸多方面完善自己，公司目前已與千余家各類(lèi)客戶(hù)進(jìn)行長(zhǎng)期戰(zhàn)略合作，提供專(zhuān)業(yè)的網(wǎng)站建設(shè)與運(yùn)營(yíng)服務(wù)。我們的口號(hào)：廣結(jié)良緣、震古爍今！ |
免費(fèi)熱線(xiàn)：400-166-3538
咨詢(xún)QQ ：
微信咨詢(xún) : chunhua19820
直接咨詢(xún) 
