Articles of 文档

使用phoenix_api_docs

我想用https://github.com/smoku/phoenix_api_docs来创build一个doc api,但是我遇到了一个问题,正如文档中所指出的那样,我把test_helper.exs放在了这里: PhoenixApiDocs.start ExUnit.start(formatters: [ExUnit.CLIFormatter, PhoenixApiDocs.Formatter]) 当我运行混合testing,控制台显示我这样的: 09:22:51.173 [error] GenEvent handler PhoenixApiDocs.Formatter installed in #PID<0.323.0> terminating ** (UndefinedFunctionError) function WhitespaceEx.Application.Router.__routes__/0 is undefined (module WhitespaceEx.Application.Router is not available) WhitespaceEx.Application.Router.__routes__() (phoenix_api_docs) lib/phoenix_api_docs/generator.ex:26: PhoenixApiDocs.Generator.routes_docs/2 (phoenix_api_docs) lib/phoenix_api_docs/generator.ex:12: PhoenixApiDocs.Generator.run/0 (phoenix_api_docs) lib/phoenix_api_docs/formatter.ex:22: PhoenixApiDocs.Formatter.save_blueprint_file/0 (phoenix_api_docs) lib/phoenix_api_docs/formatter.ex:9: PhoenixApiDocs.Formatter.handle_event/2 (stdlib) gen_event.erl:573: :gen_event.server_update/4 (stdlib) gen_event.erl:555: :gen_event.server_notify/4 (stdlib) gen_event.erl:296: :gen_event.handle_msg/6 (stdlib) proc_lib.erl:247: :proc_lib.init_p_do_apply/3 Last message: {:suite_finished, […]

有没有办法扫描JavaScript文件的目录和文件的function?

林想知道是否有一种方法来扫描JavaScript文件的目录和文件的function? 我在想可能有一个nodejs也可以做到这一点? 我只是不想要添加任何东西本身(评论jsdoc等) 我们网站上有100多个模块,我想快速logging下来,以了解还在使用什么模块。 任何build议将是伟大的。

如何阅读JavaScript框架文档?

来自.NET的世界,我有一个很难的JavaScript框架的文档。 我将以“Node.js MongoDB驱动程序API”为例。 有一个Collection对象,它有count()方法。 这里是它的链接: http : //mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#count 从那里我看到count()需要三个参数: count(query, options, callback) 起初我以为我需要提供他们所有三个为了使用这种方法。 但是,在这个方法的示例代码中,我发现它有时只使用一个,有时只使用一个参数: // Perform a total count command collection.count(function(err, count) { test.equal(null, err); test.equal(4, count); // Peform a partial account where b=1 collection.count({b:1}, function(err, count) { test.equal(null, err); test.equal(1, count); db.close(); }); 在第一种情况下,它只用callback参数调用count(),而在第二种情况下它提供了options和callback 。 没有使用原始方法描述中所述的全部三个参数的示例。 我的问题是怎么能知道这样的事情? 我的意思是,如果在这个文件中没有例子,我怎么知道这是可能的? 另外我怎样才能确定,如果没有这样的例子覆盖的方法有其他一些可能的用法? 我知道,只提供一些参数来调用javascript函数是完全合法的,函数应该能够根据实现来处理它。 但作为API的消费者,我不想查看函数实现来确定我可以传递什么样的参数组合。 我觉得这个文档是不完整的(我拿这个mongodb驱动程序作为例子,但我碰到类似的问题与其他js框架文档)。 在阅读javascript文档时,是否应该有一些理由,试图理解不同框架的API,如何知道什么是可能的,什么是不是等…?

Express:查询是否存在文档

我正在使用mongo在Express中开发一个应用程序。 我必须检查集合中是否存在特定的文档。 我正在这样做: router.route('/').post(function (req, res, next) { var name = req.body.name; var dept = req.body.dept; var arr = mongoose.model('User').find({'name': name, 'dept': dept}); if(arr.length() > 0){ //do something } } mongoose.model('User').find({'pemail': email, 'password': password}); 实际上返回,因为当我运行的应用程序,它给了我这个错误: TypeError:undefined不是一个函数 任何帮助?

如何阅读Node.js API文档? 例如“stat(2)”是什么意思?

例如,让我们考虑文件系统模块及其fs.stat(path,callback)方法。 这是一个描述: fs.stat(path,callback) asynchronousstat(2)。 callback得到两个参数(err,stats),其中stats是一个fs.Stats对象。 请参阅下面的fs.Stats部分了解更多信息。 stat(2)是什么意思? 这不是一个链接,它不跟随任何地方,它只是一个string。 如何理解? API文档有这么多引用,这些都是什么意思?

显示能够在线编辑的文档

我使用Node-ViewerJs在基于nodejs的web应用程序中显示不同格式的文档。 但是除pdf外,ViewerJs只支持Open Document Format。 有没有其他好的解决scheme来显示不同格式的文档(例如doc,docx,xl​​s,xlsx),最好能够通过网页浏览器在线编辑文档? PS:我正在寻找一些完全自主或脱机(换句话说)解决scheme而不是基于云的解决scheme。

StyleDocco输出文档确实应用了CSS

我正在使用grunt-styleguide,我的模板被设置为styledocco – 生成CSS样式指南。 当我运行任务时,它可以工作,但styledocco输出文件不会在演示元素上应用CSS。 我的styleguide的咕噜声: styleguide: { dist: { options: { framework: { name: "styledocco" }, name: "FE KICKSTARTER V1.o" }, files: { "assets/css/styleguide": "assets/css/**/*.less" } } } 我的输出如下: 在图片上方,testing文本和button应该已经应用了样式。 我已经检查configuration,事情似乎很好,但不知道缺less什么。 任何帮助?

node.js模块API文档,如pydoc?

有没有像pydoc一样可以在已安装的node_modules上工作的库或二进制文件? 每次检查每个模块或者使用js文件来检查API的使用真的让我感到困扰。 由于node.js已经为我们提供了一个很好的检查function,我相信必须完成一些工作,或者至less要完成logging已安装的node_modules的工作,但是我找不到任何东西。 任何人都可以指导我?

如何运行grunt docular-server?

如果我执行grunt docular-server命令 我收到错误消息: ERROR: Could not start node server [TypeError: Object #<Object> has no method 'server'] 那么docular-server没有运行。 我安装了grunt来编写我的代码的文档,如下所示: `npm install -g grunt-cli` `npm install grunt grunt-docular` 我的Gruntfile.js看起来像这样: module.exports = function(grunt) { // Project configuration. grunt.initConfig({ pkg: grunt.file.readJSON('package.json'), docular: { groups: [], showDocularDocs: true, showAngularDocs: true } }); // Load the plugin that provides the "docular" […]

跳转到vim中的节点文档

所有, 我最近开始做一些JavaScript编码。 我使用了Python模式的vim插件 ,我正在寻找一个类似function的javascript插件。 我已经获得了大部分重要的东西,所以我最喜欢的是一个可以直接跳转到内置库的文档的插件。在python模式下,这是通过将光标放在函数调用并按下D 。 它打开与文档的内容的新的分裂。 Cursory谷歌search没有透露任何类似的javascript / node.js所以我想知道是否有可用的东西,或者如果我需要推出自己的。