下面是stackoverflow網站上網友針對你看到過的最好的程式碼註釋是什麼樣的？

笑死了，笑歸笑，但是，我感覺大家看看就好，程式碼修飾還是要遵循原則！

原則：

1、註釋形式統一

在整個應用程式中，使用具有一致的標點和結構的樣式來構造註釋。如果在其它專案中發現它們的註釋規範與這份文件不同，按照這份規範寫程式碼，不要試圖在既成的規範系統中引入新的規範。

2、註釋內容準確簡潔

內容要簡單、明瞭、含義準確，防止註釋的多義性，錯誤的註釋不但無益反而有害。

最好的註釋是長篇連載的故事。第一次上班，老闆要接手一個別人的專案，讓我儘快熟悉原始碼。於是我在載入部分看到了一個程式設計師豐富細膩的心思，他為了讓我們閱讀不枯燥把註釋寫成了一部網路小說鉅作，我想他一定是每天加班加點的在IDE裡敲字。老闆一定認為他努力加班工作認真加薪，他自己寫故事也很有成就感，未來也許能向盜墓筆記那也火一把。現在每天上班都迫不及待的開啟編輯器閱讀註釋，下班也不想走還在閱讀註釋，老闆覺得我也很努力，提前轉正了。我想這就是最好的註釋了。

寫故事之類的梗相當相當無聊，我見過最好用的是有人在後臺程式碼裡寫前端呼叫的樣式，在前端程式碼裡寫互動流程，後臺返回資料的示例。非常好用，每個人都讚不絕口。

那麼問題來了，這麼叼的程式碼在哪裡見到的。(⊙_⊙)，姐寫的！

最好的注視就是，統一風格且有可讀性的檔名，檔案路徑，版本管理平臺，程式語言，編譯方式，程式碼。然而這些不能是要求碼農時時刻刻記著得怎麼做，而是透過自動的(可以自動的一定得自動，但code review這種還是需要人工)檢查機制保證的，在這種環境中碼農不自覺的就形成了寫好程式碼的習慣。有幸第一家上班的公司就是這種風格，讀寫程式碼都很爽，甚是懷念，可惜公司賺不到錢 黃了。