摘要：下面就為大家?guī)韨€人認為的常見的爛注釋風格 。相信作為程序員的大家，只要寫代碼，就會自己寫及看到別人寫的代碼注釋 。所以，我們往往會遇到“百花齊放， 百家爭鳴”般的注釋 。程序員最討厭的10件事，0:寫注釋，1:別人不寫注釋 。作為一個老IT人，看了那么多年代碼，也就看了那么多年注釋 ?？梢哉f，好代碼不一定有好注釋，但爛代碼基本和爛注釋共存 。下面就為大家?guī)韨€人認為的常見的爛注釋風格，希望能對大家在日后的工作中，帶來一絲絲的幫助 。排名不分先后：1. 注釋上帶聯(lián)系方式，TODO事項，問題單需求鏈接等 。這種風格其實體現(xiàn)了工程師沒有意識去利用好現(xiàn)代的平臺技術(shù)，還停留在90年代的編碼習慣 。2020年了， git類軟件已經(jīng)是軟件開發(fā)的首選代碼托管平臺了，問題單需求鏈接和聯(lián)系方式的最佳位置應(yīng)該是Git的交日志上，TODO事項應(yīng)該使用Git的issue管理 。這種注釋看到就應(yīng)該刪掉 。例如以下兩種注釋
文章插圖
文章插圖
2. 注釋上帶有一部分設(shè)計內(nèi)容 。這些內(nèi)容最大的問題是，沒人知道它是真是假，更沒人知道它是否完整，刪掉了吧，又有點可惜，萬一有點用呢？不刪吧，又看著不舒服 。出現(xiàn)這種問題的最大原因是，團隊內(nèi)沒有太好的地方承載這類文檔 。2020年了，可以試試 Github的pages平臺 。3. 注釋上寫how，而不是why 。這種大家都很清晰了，一致認為是不應(yīng)該的 。就不多說了，參考下面的例子
文章插圖
4. 對代碼的使用說明，例如方法如何調(diào)用，各項參數(shù)的說明，會拋出什么異常 。例如以下的例子便是 。有空寫這種注釋，還不如把測試用例寫好，通過用例來告訴用戶應(yīng)該如何使用 。
文章插圖
5. 代碼某種算法的特殊說明，這種比較有爭議性，嚴格來說，不算是爛注釋，但如果這種注釋沒有嚴格和代碼一起管理（例如改了代碼要同步改注釋），那么這種注釋就沒有好過有了 。所以這雖然嚴格來說是一個管理原因，但2020年了，我更推薦把這種注釋寫到交日志上 。怎么說呢？我以Git的這段交來說明這個問題，這段交只設(shè)計到一個變量的非null判斷，很多人可能就直接交了，有些人也會在代碼上加上注釋，闡述為什么要做這個非null判斷，但作者最終是選擇了在交日志上闡述這段邏輯，而且足足寫了20行（刨去一些個人簽名，有效行數(shù)也很多），想象一下把這20行寫到代碼中，會對代碼的閱讀產(chǎn)生多大的影響呀？但不寫，又會對后面的維護帶來問題 。
文章插圖
文章插圖
本文分享自華為云社區(qū)《我的注釋我做主》，原文作者：周大仙人。
以上關(guān)于本文的內(nèi)容，僅作參考！溫馨提示：如遇健康、疾病相關(guān)的問題，請您及時就醫(yī)或請專業(yè)人士給予相關(guān)指導!
「愛刨根生活網(wǎng)」www.malaban59.cn小編還為您精選了以下內(nèi)容，希望對您有所幫助：- 軟件開發(fā)培訓學校:怎么選擇專業(yè)正規(guī)的Unity3d游戲開發(fā)培訓學校？
- 軟件開發(fā)培訓學校:計算機培訓學校主要學什么？
- 護腰背5個妙法可防背部肌肉的拉傷和疼痛
- 軟件開發(fā)培訓學校：IT行業(yè)和程序員一樣嗎？
- 軟件開發(fā)培訓學校：女程序員平均月薪1.5萬，學習投資是男程序員的1.5倍
- 軟件開發(fā)培訓學校：各個大廠的 404 頁面！后一個笑shi我了...
- 男士更有效的健身的須知5個細節(jié)
- 軟件開發(fā)培訓學校：牛逼至極！用這個神器看代碼太舒服了
- vim下一頁:走上坡路的人，有這5個習慣
- 軟件開發(fā)培訓學校：網(wǎng)校系統(tǒng)可以幫助教育企業(yè)解決哪些問題？