如何算是好的程式comment

其實好的comment不一定需要每一行都解釋一次, 這樣只會太長沒有人想看。

建議您可以考慮用comment block的方式, 在每一個function的開始的地方加上一個大的comment區, 解釋老的作用。

以下是例子:
先說明一下PrintText這個function的作用。
再說明一下需要的variable是甚麼。(x, y, Text)。
最後說明一下Return的是甚麼東西。
其餘有Side effect/Remarks的可以自行增加。這樣其他人想知道這個function做甚麼/如何使用時, 可直接看您的Comment block


圖片參考：http://imgcld.yimg.com/8/n/HA07783203/o/20121102150817.jpg


而indentation基本上是一種個人習慣, If Then Else/Loop正常也一定會加, 其他可以看自己的情況。以下是簡單的例子, 左邊沒有indentation, If Then Else會亂七八糟很難看。右邊是有indentation,If Then Else讀起來也更清楚。

圖片參考：http://imgcld.yimg.com/8/n/HA07783203/o/20121102151522.jpg



圖片參考：http://icepacific.com/images/yahooknowledge/signature_ice2.jpg