2013-09-16 108 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