欧美一级特黄大片做受成人-亚洲成人一区二区电影-激情熟女一区二区三区-日韩专区欧美专区国产专区

成都養(yǎng)成好習(xí)慣關(guān)于代碼注釋的7個技巧

2023-03-01    分類: 網(wǎng)站建設(shè)

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

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

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

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

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

2. 使用段落注釋

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

3. 對齊注釋行

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

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

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

要避免沒用的注釋,例如

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

5. 要有禮貌

應(yīng)當(dāng)避免沒有禮貌的注釋,例如“要注意一些愚蠢的用戶會輸入一個負(fù)數(shù)”,或者“修正由菜鳥工程師寫的愚蠢得可憐的代碼而導(dǎo)致的副作用”。這樣的注釋對于代碼的寫注釋的人來說并沒有任何好處,同時你永遠(yuǎn)都不會知道將來這些注釋會被誰來閱讀,你的老板,一個客戶或者是剛才被你數(shù)落的愚蠢得可憐的工程師。

6. 直截了當(dāng)

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

7. 使用統(tǒng)一的風(fēng)格

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

網(wǎng)站題目:成都養(yǎng)成好習(xí)慣關(guān)于代碼注釋的7個技巧
分享路徑:http://www.aaarwkj.com/news/240542.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站內(nèi)鏈動態(tài)網(wǎng)站、定制網(wǎng)站App開發(fā)、網(wǎng)站導(dǎo)航、定制開發(fā)

廣告

聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)

小程序開發(fā)
久久最新最热视频精品| 中文字幕韩国三级电影| 白天躁晚上躁天天躁在线| 国产精品v一区二区三区| 69人妻一区二区三区蜜桃| 久久精品亚洲国产成人av| 日日夜夜久久国产精品| 国产精品大屁股一区二区| 国产黄色三级电影在线| 亚洲一区免费在线视频| 亚洲日本精品国产第一区| 色综合一区二区日本韩国亚洲 | 国产精品欧美久久久久无| 久久亚洲av电影网站| 调教亚洲另类唯美第二页| 欧美亚洲国产日韩熟女| 99精品午夜福利在线| 99热成人精品热久久| 国产v精品欧美精品v日韩| 久久国产亚洲欧美一区| 91日本在线免费观看视频| 国产亚洲综合精品综合区| 韩国理伦三级做爰观看| 日韩在线国产精品视频| 人人妻人人澡人人爽久久av| 亚洲欧美一区二区中文字幕| 尤物视频精品在线观看| 国产91在线观看网站| 美女av在线免费观看| 人妻天天爽夜夜爽欧美色| 日韩人妻中文字幕在线视频| 一区二区三区在线观看日韩| 欧美黄片一区二区三区三| 亚洲av日韩精品久久久| 国产欧美日韩综合激情| 亚洲黄色大片在线免费观看| 亚洲精品国产精品成人 | 日本成人一区二区三区在线| 国产白丝免费在线观看| 97人妻人人澡人人爽| 午夜福利影片免费观看|