歡迎進入含山縣吳楚新銳網絡科技有限公司官網!

服務熱線:0551-64935250

含山縣吳楚新銳網絡科技有限公司

網站制作(Do)中關于(At)代碼注釋的(Of)7個(Indivual)技巧

1. 對齊注釋行
對于(At)那些在(Exist)行末寫有注釋的(Of)代碼,應該對齊注釋行來使得方便閱讀
有些開發人(People)員使用(Use)tab來對齊注釋,而另外一(One)些人(People)會用(Use)空格來對齊。由于(At)tab在(Exist)不(No)同的(Of)編輯器和(And)集成開發環境中會有所不(No)同,所以(By)最佳的(Of)方法是(Yes)使用(Use)空格來對齊注釋行。
2. 使用(Use)統一(One)的(Of)風格
有些人(People)覺得注釋應該讓非程序員也能看懂。另外一(One)些人(People)覺得注釋需要(Want)面對的(Of)讀者隻是(Yes)程序員。無論如何,正如Successful Strategies for Commenting Code中所說的(Of),最重要(Want)的(Of)是(Yes)注釋的(Of)風格需要(Want)統一(One),并且總是(Yes)面向相同的(Of)讀者。就自己而論,我懷疑非程序員是(Yes)否會去讀代碼,所以(By)我覺得注釋應該面向程序員來寫。
3. 對不(No)同級别的(Of)代碼進行注釋
對于(At)不(No)同級别的(Of)代碼塊,要(Want)使用(Use)統一(One)的(Of)方法來進行注釋。例如:
對于(At)每一(One)個(Indivual)類,需要(Want)包含一(One)段簡明扼要(Want)的(Of)描述,作(Do)者和(And)上(Superior)一(One)次修改的(Of)時(Hour)間
對于(At)每一(One)個(Indivual)方法,需要(Want)包含這(This)個(Indivual)方法的(Of)用(Use)途,功能,參數以(By)及返回結果
當你在(Exist)一(One)個(Indivual)團隊裏面的(Of)時(Hour)候,采用(Use)一(One)套注釋的(Of)标準是(Yes)非常重要(Want)的(Of)。當然,使用(Use)一(One)種大(Big)家都認可的(Of)注釋約定和(And)工具(例如C#的(Of)XML注釋和(And)Java的(Of)Javadoc)在(Exist)一(One)定程度上(Superior)能推動這(This)項任務。
4. 使用(Use)段落注釋
首先把代碼塊分解成多個(Indivual)“段落”,每一(One)個(Indivual)段落都執行單一(One)的(Of)任務;然後在(Exist)每一(One)個(Indivual)“段落”開始之前添加注釋,告訴閱讀代碼的(Of)人(People)接下來的(Of)這(This)段代碼是(Yes)幹什麽用(Use)的(Of)
5. 不(No)要(Want)侮辱閱讀者的(Of)智慧
這(This)不(No)單把時(Hour)間浪費在(Exist)寫沒用(Use)的(Of)注釋上(Superior)面,同時(Hour)也在(Exist)分散讀者的(Of)注意力。
6. 直截了(Got it)當
不(No)要(Want)在(Exist)注釋裏面寫過多的(Of)廢話。避免在(Exist)注釋裏面賣弄ASCII藝術,寫笑話,作(Do)詩和(And)過于(At)冗長。簡而言之就是(Yes)保持注釋的(Of)簡單和(And)直接。
在(Exist)線客服
服務熱線