Docco文檔生成器

Docco 是一個應(yīng)急用的文檔生成器。使用 Literate CoffeeScript 編寫。可生成 HTML 文檔來顯示你在代碼中的注釋。使用 Markdown 語法，代碼通過 Pygments 語法高亮。

文檔生成功能

通過復(fù)制靜態(tài)代碼，讀取所有源文件，將它們分成注釋 + 代碼兩個部分，用適當(dāng)?shù)恼Z言突出顯示每個文件并在 HTML 模板中將它們打印出來，來為我們配置的源文件生成文檔。

document = (options = {}, callback) ->
  config = configure options

  fs.mkdirs config.output, ->

    callback or= (error) -> throw error if error
    copyAsset  = (file, callback) ->
      return callback() unless fs.existsSync file
      fs.copy file, path.join(config.output, path.basename(file)), callback
    complete   = ->
      copyAsset config.css, (error) ->
        return callback error if error
        return copyAsset config.public, callback if fs.existsSync config.public
        callback()

    files = config.sources.slice()

    nextFile = ->
      source = files.shift()
      fs.readFile source, (error, buffer) ->
        return callback error if error

        code = buffer.toString()
        sections = parse source, code, config
        format source, sections, config
        write source, sections, config
        if files.length then nextFile() else complete()

    nextFile()

更多詳情請查看軟件文檔