记录Node.js项目

问题描述

|                                                                                                                   关闭。这个问题是基于意见的。它当前不接受答案。                                                      

解决方法

JSDoc是JavaDoc的端口。因此，基本上，文档假定传统的OOP，并且不适合JavaScript。 我个人建议使用docco注释您的源代码。下划线，主干，docco可以找到它的示例。 croc可以替代docco 至于实际的API文档，我个人从注释中发现自动生成的文档仅对JavaScript不起作用，建议您手写API文档。 例如下划线API，Express API，nodejs API，socket.io文档 类似的StackOverFlow问题 生成Javascript文档     ,YUIDoc是一个Node.js应用程序，它使用类似于Javadoc和Doxygen之类的语法从源注释中生成API文档。 YUIDoc提供： 实时预览。 YUIDoc包含一个独立的文档服务器，使您在编写文档时预览文档变得轻而易举。 现代标记。 YUIDoc生成的文档是一个有吸引力的，功能强大的Web应用程序，具有真实的URL和适用于无法运行JavaScript的蜘蛛和其他代理的优美的后备。 广泛的语言支持。 YUIDoc最初是为YUI项目设计的，但它并不与任何特定的库或编程语言绑定。您可以将其与任何支持/ * * /注释块的语言一起使用。     ,  注意：Dox不再输出HTML，而是描述解析代码的JSON斑点。这意味着下面的代码无法再正常工作了... 我们现在暂时使用Dox。 Raynos提到了与docco很像的东西，但是将它们全部封装在一个HTML文件中以进行输出。 我们入侵了我们的

makefile

：

JS_FILES := $(shell find lib/ -type f -name \\*.js | grep -v 3rdparty)

#Add node_modules/*/bin/ to path:
#Ugly \'subst\' hack: Check the Make Manual section 8.1 - Function Call Syntax
NPM_BINS:=$(subst bin node,bin:node,$(shell find node_modules/ -name bin -type d))
ifneq ($(NPM_BINS),) 
    PATH:=${NPM_BINS}:${PATH}
endif

.PHONY: doc lint test

doc: doc/index.html

doc/index.html: $(JS_FILES)
    @mkdir -p doc
    dox --title \"Project Name\" $^ > $@

它不是有史以来最漂亮或最有效的文档（并且dox有很多小错误）-但我发现它工作得很好，至少对于小项目而言。     ,抱歉，一年前我还没有使用StackExchange，但是我相信您原来的问题的答案是使用@memberOf标记：

/** @namespace */
database = {};

/**
 * @class
 * @memberOf database
 */
function Foo() { ... };

http://code.google.com/p/jsdoc-toolkit/wiki/TagMemberOf 当您提出问题时，此标签可能存在或不存在。     ,找到了一个非常好的解决该问题的方法：doxx。 如上所述，它使用dox并将其转换为漂亮的HTML。用法很好，对我来说很棒。 https://github.com/FGRibreau/doxx     ,我与JSDoc一起工作，除简单外，它还非常高效，但是当项目中有许多备用库时，开发就相当复杂。我发现Groc是一个基于

Docco

的非常好的工具，并且可以与其他语言一起使用，例如：Python，Ruby，C ++等。 此外，在GitHub中使用

Groc

与Markdown一起工作时，使用git作为版本控制时效率会更高。进一步帮助组装页面以在GitHub上发布。 您还可以使用任务管理器

GruntJS

至

grunt-groc

示例： 安装包：

npm install grunt-groc --save-dev

在您的任务文件中配置：

grunt.loadNpmTasks(\'grunt-groc\');

和配置任务：

// Project configuration.
grunt.initConfig({
   groc: {
    coffeescript: [
       \"coffee/*.coffee\",\"README.md\"
   ],options: {
       \"out\": \"doc/\"
   }
 }

}）; 对于运行任务：

grunt.registerTask(\'doc\',[\'groc\'])