2013-09-16 45 views
3

我正在使用docco作为创建coffeescript文档的工具。Docco忽略评论块

默认情况下,我在coffeescript源文件中创建的每条评论都被视为文档并移至左侧(解释性)列。 问题是,在我的源代码中有一些代码行注释掉了,留作候补选项,我想保留在右侧(代码)列中。

有没有办法告诉docco-“不要碰那个,把它留下来就像是一个普通的代码”? “#!”或“#ignore”也许? 在此先感谢。

回答

1

你试过了吗?它会忽略#! hashbang行。

忽略hashbangs和插补...

 l.commentFilter = /(^#![/]|^\s*#\{)/ 
     languages 
    languages = buildMatchers languages 

,从源头上线277 https://github.com/jashkenas/docco/blob/master/docco.litcoffee

如果不出意外,你应该能够编辑源添加任何退出你想在那里。

+0

说实话 - 是的。但我会再试一次;也许我没有注意到它的工作原理(“#!” - 想法只是盲目猜测)。 编辑:是的,它不起作用。我应该将任何参数传递给docco吗? –

+0

很奇怪。如果您查看源代码的第277行,您会发现它会尝试忽略那些https://github.com/jashkenas/docco/blob/master/docco.litcoffee –

+1

,因为上面的代码隐藏了,使用'#{docco忽略'为我工作。 – lab419