0
首先，在這個問題中，我想遠離關於源代碼評論是好還是壞的爭論。我只是想更清楚地理解人們在談論評論時告訴你爲什麼，什麼或如何的意思。什麼是評論的例子，告訴你爲什麼而不是如何或什麼？
我們經常看到像「評論應該告訴你爲什麼;代碼本身應告訴你如何」的指導方針。很容易同意抽象層面的陳述。但是，人們通常會像教條一樣放棄這種想法，並且無需進一步解釋即可離開房間。我已經看到這種用法在很多不同的地方和背景中，看起來人們可以在標語上達成一致，但他們似乎完全是在談論不同的事情。
所以，回到問題：如果評論應該告訴你爲什麼，這是什麼，我們在說什麼？這就是爲什麼這段代碼首先存在的原因嗎？這是代碼應該做什麼？如果有人能夠給出一個明確的解釋，我會非常感激，然後添加一些很好的例子（壞例子並不是真的需要，但可以隨意添加它們以作對比）。
請不要立即關閉這個問題作爲重複或論戰。我努力使它非常客觀。關於評論是好還是壞，有很多問題，但沒有人提到哪些評論的具體問題可以告訴你爲什麼。
感謝，
我不要以爲這是一個合適的問題。更可能是程序員。也許這已經有所幫助：http://programmers.stackexchange.com/questions/119600/beginners-guide-to-writing-comments。 –
謝謝菲利克斯，這肯定有幫助。另一方面，這個線索有很多人放棄同樣的誡命，然後沒有提供清楚的解釋或好的例子。 – rick