網站制作中關于代碼注釋的7個技巧

閱讀 ?·? 發布日期 2020-07-01 07:00 ?·? admin
網站制作中關于代碼注釋的7個技巧,南京網站建設網站設計南京網站制作★網頁設計-599元全包;企業網絡推廣☆南京網站優化seo☆關鍵詞排名☆百度快照-2200元全年展示;做網站優化排名-南京網站建設公司?13172194676(注:選好網站模板,請聯系客服,百度云盤下載提取網站模板)http://m.lanshengjiancai.cn/nanjing/

1. 對齊注釋行

對于那些在行末寫有注釋的代碼,應該對齊注釋行來使得方便閱讀

有些開發人員使用tab來對齊注釋,而另外一些人會用空格來對齊。由于tab在不同的編輯器和集成開發環境中會有所不同,所以最佳的方法是使用空格來對齊注釋行。

2. 使用統一的風格
有些人覺得注釋應該讓非程序員也能看懂。另外一些人覺得注釋需要面對的讀者只是程序員。無論如何,正如Successful Strategies for Commenting Code中所說的,最重要的是注釋的風格需要統一,并且總是面向相同的讀者。就自己而論,我懷疑非程序員是否會去讀代碼,所以我覺得注釋應該面向程序員來寫。

3. 對不同級別的代碼進行注釋

對于不同級別的代碼塊,要使用統一的方法來進行注釋。例如:

對于每一個類,需要包含一段簡明扼要的描述,作者和上一次修改的時間

對于每一個方法,需要包含這個方法的用途,功能,參數以及返回結果

當你在一個團隊里面的時候,采用一套注釋的標準是非常重要的。當然,使用一種大家都認可的注釋約定和工具(例如C#的XML注釋和Java的Javadoc)在一定程度上能推動這項任務。

4. 使用段落注釋

首先把代碼塊分解成多個“段落”,每一個段落都執行單一的任務;然后在每一個“段落”開始之前添加注釋,告訴閱讀代碼的人接下來的這段代碼是干什么用的

5. 不要侮辱閱讀者的智慧

這不單把時間浪費在寫沒用的注釋上面,同時也在分散讀者的注意力。

6. 直截了當

不要在注釋里面寫過多的廢話。避免在注釋里面賣弄ASCII藝術,寫笑話,作詩和過于冗長。簡而言之就是保持注釋的簡單和直接。