用HTML標記的古怪代碼注釋
英文原文：My weird code commenting style based on HTML tags
現在我明白了，我在編程方面的很多做法都是古怪的、不入流的，不過，對我而言，多多少少是有幫助的。我的網站比大部分網站，肯定存在更多的問題，但是我交付的速度快了不少。你不都懂的。
我從來無法正確學到的一件事，就是注釋我的代碼。人們通常注釋代碼的方式如下：
上面的代碼是從 PHP The Right Way 直接摘錄的。我糾結的地方在于，代碼縮進越深，代碼就變得越發難以理解。如果你深入兩個 foreach 循環，你該如何知道這部分代碼起始何處？問題在于注釋無法以某種方式來分割代碼。你看不到某段代碼的結尾。
你可以使用函數把代碼簡化為一行，這解決了很多問題。但是把每個小段代碼弄成函數，也會減慢你的速度。
是否有一個折衷方案呢？
我受 HTML 的啟發，其代碼常常非常清晰，因為你能看到一個標簽從哪兒開始、到哪兒結束。一目了然，下面是我相應做出的注釋風格：
我在 PHP、JavaScript、Obj-C、甚至 Shell 腳本里使用這種注釋風格，實際上對于我快速地搞清楚要編輯某個文件的哪個部分、以及其功能，讓我節省了大量時間。
更有意思的是，如果你在用 Sublime Text，那么你還能折疊標簽之間的整個代碼，比如：
這可能違背了在 Hacker News 游蕩的、留著大胡子的委員會編寫的編碼法則的宏大指導。不過還行，我沒有留胡子。
順便提一下，如果你想關注我的更多冒險經歷，請訪問我的 推ter。
譯文： 《用 HTML 標記的古怪代碼注釋 》 臘八粥
本文由用戶 jopen 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。
轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。
本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！