在计划中注释代码

问题描述 投票:22回答:3

我正在看一些代码,在 SchemeFestival 却似乎搞不清楚评论的内容。目前,我可以看到 ;, ;;;;; 用来表示注释行。网络上的其他资料显示,上述的一些方法也许可以用来表示多行注释。我的问题是:

  1. 什么是不同的 ;, ;;;;; 用于评论?
  2. 什么时候应该使用其中一种而不是另一种?
  3. 有没有其他的,我认为更理智的方式来注释代码?Scheme?
scheme comments
3个回答
17
投票

注释字符是 ;,后面的任何行都会被忽略。 这两者的区别是视觉上的。 我经常看到,如果注释是在有代码的行上,则用单个的;;;如果注释是自己在行上,则用;;;如果是某种标题。 注释中最重要的事情很可能是遵循你在代码中看到的任何约定。


41
投票

你提到的三种形式都是单行注释。双分号最初可能是作为Dorai Sitaram的SLaTeX排版包中的一个提示出现的,即注释要作为普通文本而不是程序文本进行排版。

Scheme也有多行注释。

尤其是R6RS,似乎和Racket一样,允许使用 #||# 来开始和结束多行评论。此外,非常华丽的 #; 组合注释出一个完整的s表达式。所以,例如,如果你写

#;(define (terrible-function a)
    (totally-broken-code
     here))

整个定义被认为是注释出来的。


0
投票

MITGNU计划允许使用 ; 用于单行评论和 #||# 分别用于打开和关闭多行注释。刚在10.1.10版本上测试过。

© www.soinside.com 2019 - 2024. All rights reserved.