評論代碼AS3 - 不是API

Question

您是否認爲需要評論代碼，除非是API？

我的意思是，一個很好的代碼。用自我解釋變量和方法。

Theres需要評論一個好的代碼嗎？

謝謝。

Answer 1

這是一個很好的問題，但也很主觀。如果你編寫的代碼非常可靠並且有精心設計的應用程序，那麼幾乎其中的每一部分都是不言自明的（自我記錄）。但是，在駁回評論意見之前，問問自己是否確實如此。

也就是說，好的評論通常會闡明代碼，包，類的更大意圖;他們可以更高級地概述您正在做什麼，而不是「解釋」幾行內容。當然，評論難以理解的代碼片段（複雜的算法）是有用的。

無論如何，如果您的代碼僅用於私人用途，並且您的項目範圍有限，您不必亂丟代碼，只需在您認爲需要澄清時直接發表評論。當你稍後返回一段代碼並修改它時，你經常會很高興。