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

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

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

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

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

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

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

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

2. 使用段落注釋

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

3. 對齊注釋行

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

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

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

要避免沒用的注釋,例如

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

5. 要有禮貌

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

6. 直截了當

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

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

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

標題名稱:成都養(yǎng)成好習慣關于代碼注釋的7個技巧
轉(zhuǎn)載注明:http://aaarwkj.com/news42/240542.html

成都網(wǎng)站建設公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站建設、網(wǎng)站設計、網(wǎng)頁設計公司、微信公眾號、網(wǎng)站排名、搜索引擎優(yōu)化

廣告

聲明:本網(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)

網(wǎng)站建設網(wǎng)站維護公司
日韩国产欧美亚州精品| 国产性做爰片免费网站| 日本熟人妻中文字幕在线| 日本大片在线一区二区三区| 国产精品毛片一区二区三| 男女真人啪啪视频免费| 精品久久久久久久中文字幕| 亚洲国产综合亚洲综合国产| 久久精品亚洲夜色国产av| 大香蕉一区二区亚洲欧美| 国产高跟丝袜女王调教| 91麻豆精品在线观看| 国产三级在线观看91| 丁香六月综合激情啪啪啪| 中文字幕国产精品专区| 亚洲综合av伊人久久| 刚出嫁新婚少妇很紧很爽| 日韩欧美中文字幕在线等| 不卡的av中文字幕在线播放| 国内传媒视频免费观看| 久娜娜精品视频在线观看| 久久久偷拍美女撒尿尿| 日本精品1区国产精品| 一区二区三区人妻日韩| 国产伦国产一区二区三区在线观看| 日韩欧美人妻中文字幕| 国产高清在线不卡一区| 91九色在线精品一区| 性生活视频在线观看免费| 成人自拍偷拍在线视频| 国产免费成人在线视频| 成人黄色18免费网站| 亚洲经典日韩欧美一区| 国产一区二区精品不卡| 天堂av好男人亚洲精品| 中文字幕在线五月婷婷| 在线观看免费视频成人播放| 日韩精品专区在线影院重磅| 色综合久久婷婷色综合网| 女同亚洲一区二区三区| 女同同性av观看免费|