问题标签 [docco]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
0 回答
162 浏览

javascript - 将选项传递给 Docco 标记

我正在使用 grunt-docco ( https://github.com/DavidSouther/grunt-docco ) 在 Grunt 工作流程中的项目上运行 docco。

但是,我遇到了一个问题(https://github.com/DavidSouther/grunt-docco/issues/34),涉及将选项传递给标记(https://github.com/chjj/marked),这是使用Docco里面。

我的问题是——在创建 docco 实例时有没有办法传递标记的选项?docco 执行此类操作的文档对我来说并不完全清楚,但我知道必须有某种方法。

如果可以的话请帮忙!这是 grunt 任务的堆栈跟踪:

0 投票
1 回答
57 浏览

javascript - 如何更改 Docco 生成的 HTML 页面的标题?

目前 Docco 生成的任何 HTML 页面的标题都是源代码文件的名称。我该如何改变呢?我想为我生成的代码设置一个自定义标题。

0 投票
0 回答
40 浏览

gruntjs - 使用 Docco 忽略文本块

通过 Grunt (grunt-docco) 对 JavaScript 代码使用 Docco (latest)。如何忽略文本块?例如,在所有 JavaScript 文件的顶部是多行注释中的许可证信息:

或者假设我有我不处理 Docco 的代码?

0 投票
1 回答
345 浏览

html - 带有 DOCCO 线性样式的 R Markdown

我正要使用包(knitr )支持的DOCCO 线性样式编写包的小插图。knitr

在他们的示例小插图中,在 HTML 文件的开头和结尾处出现了一个漂亮的图形。

但是当我试图维护自己的小插图时,这些图形并没有出现,而是出现了一个巨大的8字母h:P,如下所示: 多科

任何人都可以告诉我为什么会发生这种情况以及如何解决这个问题吗?

我正在将我的小插图转换.Rmd.HTML使用以下语法:

小插图:

和函数来转换它:

请注意,您应该已经npm安装在您的计算机上。

通过终端安装:

然后安装docco:

感谢您的任何建议!

编辑:

首先,在markdown编译之后,我在创建它的Oracle虚拟机上的ubuntu的firefox下打开了我的小插图文件,因为我无法在Windows上下载和安装docoo。8它在输出文件中显示为丑陋。

但是当我通过电子邮件将这个文件发送给自己并在 Windows 上打开它时,它看起来完全符合我在制作时的期望。检查下面医生工作

因此,我在 Firefox 的虚拟机上打开了 knitr vignette 手册,解释了 ubuntu 上的 docco 风格,它似乎具有相同的8标志!

我认为这一定是某种编码问题?我对吗?很好,将它发送到 Windows 后效果很好:P 任何人都可以解释我这一天大部分时间都失去的废话吗?

谢谢 :)

0 投票
1 回答
62 浏览

coffeescript - 如何在 Docco 生成的文件中表示函数名称?

目标是使 fluentnode 的docco生成的文档(用 Coffee-Script 编写)尽可能易于阅读和理解。目前,我正在努力寻找在帮助页面左侧表示函数名称的最佳方式,您可以在http://o2platform.com/fluentnode/index.html访问

目前我正在探索三个语法选项:

一种) @。{function-name} ({params}) B) {ClassName}:: {function-name} ({params}) C) {ClassName}# {function-name} ({params})

例如,Array 的 .empty()方法将表示为:

一种) @。()

B)数组::()

C) 数组#empty ()

请注意,这将在特定类的文件中看到(因此在 A 上仍然很明显这与数组有关)

为了看到这一点,我在三个不同的帮助文件中使用了这些方法:


一种) @。Array.html上的 {function-name} ({params})

图片

B) {ClassName}:: {function-name} ({params}) 在Function.html

图片

C) {ClassName}# {function-name} ({params}) 在 C) http://o2platform.com/fluentnode/Number.html

图片


顺便说一句:如果有其他方式来表示这一点,请指点我现有的 docco 生成的站点来代表这些技术。

(这里也问过问题https://github.com/o2platform/fluentnode/issues/31

0 投票
1 回答
180 浏览

python - Have Pycco recognize doctests as code?

Is there any way to have Pycco recognize doctests as code and render them appropriately?

E.g. the docstring of the following function

Renders In Pycco like the following

Clearly the >>> was interpretted as indentation and code highlighting did not take effect. This seems like a common use case. is there a plugin somewhere that I'm missing?

0 投票
2 回答
983 浏览

comments - 从 SonarQube 审查中隐藏 Docco 的注释代码

我们的组织正在使用 SonarQube 来管理代码质量,并使用 Docco 来处理从代码注释生成文档。

我们在 Docco 的注释中包含诸如方法名称之类的内容与 SonarQube 中的“代码部分不应“注释掉””规则之间遇到冲突。

是否有任何已知的最佳实践让 SonarQube 忽略用于文档的注释中的代码(特别是对于 Docco 更好),同时仍然捕获已被注释掉而不是被删除的旧代码?