Tomdoc - 使用多行Ruby注释

Question

我注意到tomdoc.org只使用单行评论。但是，代码内文档的想法似乎与Ruby的多行注释（=begin ... =end）完全吻合。有谁知道为什么Tomdoc坚持使用单行评论有什么特别的理由？或者只是偏好？

Answer 1

我不知道为什么Tomdoc使用单行样式，但这里有一些我喜欢的原因：

• octothorpes的垂直墙更清楚地区分了评论 来自代码。
• =begin和=end的周围评论会增加已经展开的评论的垂直高度。
• Octothorped评论是Ruby标准，遵循该标准可以更容易地阅读其他人的代码。
• =begin和=end必须在第一列，污染缩进。