ruby - Tomdoc - 使用多行 Ruby 注释

Question

我注意到 tomdoc.org 专门使用单行注释。但是代码内文档的想法似乎与 Ruby 的多行注释 ( ) 很相配=begin ... =end。有谁知道 Tomdoc 坚持使用单行注释是否有任何特殊原因？还是仅仅是偏好？

Answer 1

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

• octothorpes 的垂直墙更清楚地将注释与代码分开。
• 围绕评论=begin并=end增加已经足够分散的评论的垂直高度。
• Octothorped 注释是 Ruby 标准，遵循该标准可以更轻松地阅读其他人的代码。
• =begin并且=end必须在第一列，弄脏缩进。