代碼即是注釋

來源:互聯網
上載者:User

有些開發人員喜歡在代碼中寫大量的注釋,認為這樣可以增加代碼的可讀性,而很多大牛卻也很少寫,之前也是不解。

 

大量的注釋的確可以協助讀代碼的人,更快得理解,但往往增加了我們的關注點,代碼看起來也不漂亮,Jobs告訴了我,什麼才是最美? 是簡約之美...

 

又想增加代碼的可讀性,又想減少甚至不用注釋,這是個矛盾嘛,像是一道永遠無解的數字遊戲,最近有些感悟,找到了答案:

 

思想:

類名,方法名,屬性名稱,變數名,即是注釋,無處不是注釋,無論一個業務多複雜的系統,只要設計合理了,處處井井有條了,即使沒有一行注釋,代碼讀起來也是很清晰,漂亮。

 

方法論:

當你有衝動要加點注釋的時候,先問下自己,要描述的邏輯是否可以封裝成方法,方法名以要寫的注釋命名。

再思考這個方法放到當前檔案是否合適,是否便於維護。

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.