幽默：好的程式碼本身就是最好的文件 - CodeWisdom

banq發表於2021-02-13

好的程式碼本身就是最好的文件。在您要新增註釋文件時，問問自己：“如何改進程式碼，以便不需要這些註釋文件？” 改進程式碼，然後對其進行記錄以使其更加清晰。 - Steve McConnell
 
眾說紛紜：

我猜這傢伙也沒有寫測試
 
程式碼格式化也起著快速理解和編輯將來的作用。
 
文件註釋掩蓋了錯誤的程式碼
 
大多數需要加入註釋文件都表明您應該重構這些程式碼塊。除非描述函式，類或其他文件字串，否則請問自己：我可以使這種複雜的控制流程或陷阱變得更容易嗎？
 
如果您在談論技術文件，那麼可以這樣做。但是功能文件還是需要的，能瞭解如何使用應用程式/功能
 
文件註釋最好是解釋“為什麼”而不是“什麼”。程式碼在做什麼，應該是顯而易見的。為什麼必須編寫該程式碼有時可以從註釋文件形式的一些解釋中受益。（banq注：文件解釋程式碼所在的上下文，但是這些上下文也是可以從其他程式碼中瞭解，如果你的程式碼是依據有界上下文劃分，那麼上下文還是可以依據程式碼自己來解釋。）
 
好的程式碼總是可以自我解釋。新增文件可以反映其有用性，而不是對其進行翻譯。

 

 

相關文章