• <rt id="ztgtn"></rt>

  • <tt id="ztgtn"></tt>

  • <rt id="ztgtn"><optgroup id="ztgtn"></optgroup></rt>

  • 全潮-在線咨詢 咨詢熱線:0755-23607481,17722631175

    咨詢熱線:0755-23607481,17722631175

    新聞資訊

    當前位置: 首頁 - App開發資訊 - APP最新熱評 - 深圳app開發:6個注釋技巧


    深圳APP開發

    深圳app開發:6個注釋技巧

    發布時間: 2017-11-22 18:10:50   作者:小潮   瀏覽次數:10

    關于不一樣等級的代碼塊,要運用統一的辦法來進行注釋

    深圳app開發:

     1. 對不一樣等級的代碼進行注釋

    關于不一樣等級的代碼塊,要運用統一的辦法來進行注釋。例如:

    關于每一個類,需求包括一段短小精悍的描述,作者和上一次批改的時間

    關于每一個辦法,需求包括這個辦法的用途,功用,參數以及回來成果當你在一個團隊里邊的時分,選用一套注釋的規范是非常重要的。當然,運用一種我們都認可的注釋約好和東西(例如C#的XML注釋和Java的Javadoc)在必定程度上能推進這項使命。

     

    2. 運用階段注釋

    首先把代碼塊分解成多個“階段”,每一個階段都履行單一的使命;然后在每一個“階段”開端之前增加注釋,通知閱覽代碼的人接下來的這段代碼是干什么用的

     

    3. 對齊注釋行

    關于那些在行末寫有注釋的代碼,應當對齊注釋行來使得便利閱覽

    有些開發人員運用tab來對齊注釋,而別的一些人會用空格來對齊。因為tab在不一樣的編輯器和集成開發環境中會有所不一樣,所以最好的辦法是運用空格來對齊注釋行。

     

    4. 不要凌辱閱覽者的才智

    要防止沒用的注釋,例如這不單把時間糟蹋在寫沒用的注釋上面,一起也在渙散讀者的注意力。

     

    5. 要有禮貌

    應當防止沒有禮貌的注釋,例如“要注意一些愚笨的用戶會輸入一個負數”,或許“批改由菜鳥工程師寫的愚笨得不幸的代碼而致使的副作用”。這樣的注釋關于代碼的寫注釋的人來說并沒有任何好處,一起你永遠都不會知道將來這些注釋會被誰來閱覽,你的老板,一個客戶或許是方才被你數說的愚笨得不幸的工程師。

     

    6. 開門見山

    不要在注釋里邊寫過多的廢話。防止在注釋里邊做作ASCII藝術,寫笑話,作詩和過于冗長。簡而言之即是保持注釋的簡略和直接。


    新东京热手机在线观看