Tomdoc - 使用多行Ruby註釋

Question

我注意到tomdoc.org只使用單行註釋。但是代碼文檔的想法似乎與Ruby的多行註釋（=begin ... =end）非常相似。有誰知道Tomdoc爲何堅持單行評論有什麼特別的理由？或者它只是偏好？

Answer 1

我不知道爲什麼Tomdoc採用單線式的，但這裏有一些原因，我喜歡它：

• octothorpes的垂直壁更清楚代碼分離的意見 。
• 圍繞着和=end的評論增加了已經分發出來的評論的垂直高度。
• Octothorped註釋是Ruby標準，遵循標準可以更容易閱讀其他人的代碼。
• 和=end必須位於第一列上，使壓痕變髒。