标签: documentation

需要require.js优化器app.build.js文档

RequireJS的优化脚本由app.build.js文件配置(它只是一个约定)这个文件定义了项目的构建方式.

此文件描述了此文件的基本用法:http://requirejs.org/docs/optimization.html#wholeproject

但我无法找到有关可用选项的任何文档.我只能找到允许我推断出我正在使用的一些选项的例子.

除了我刚刚链接的页面之外是否有任何文档?

javascript documentation requirejs r.js

3
推荐指数
1
解决办法
5861
查看次数

将XML注释移动到单独的文件中

我喜欢XML评论.然而,随着一切崩溃,每两行看起来像:

[/// summary ...]
public void CreateUser(string username, string password)[...]
Run Code Online (Sandbox Code Playgroud)

将此乘以数十或数百种方法,并且生成的折叠代码很难筛选出来. 我可以将这些注释移动到单独的XML文件中,并且仍然让Visual Studio识别该关联,以便它们仍然显示在Intellisense中吗?如果是这样,我该如何建立这种关联?我还使用SandCastle根据这些注释生成文档,因此SandCastle也必须识别该关联.

c# xml documentation visual-studio-2010 xml-comments

3
推荐指数
1
解决办法
2193
查看次数

模块:我何时应该在文档中提到所需的Perl版本?

哪一个是最高的Perl版本,我不再提及作为文档中的要求?例如,我从未见过:需要Perl 4或更高版本.

documentation perl version

3
推荐指数
1
解决办法
189
查看次数

ClojureScript API文档

学会了如何找出我正在使用lein-cljsbuild的ClojureScript版本.我在哪里可以找到cljs.core的API文档?

我不得不从博客文章中了解js-obj.

可以查看源代码,但它是一个大文件,它主要是clojure.core的东西.

api documentation clojurescript

3
推荐指数
1
解决办法
2156
查看次数

Google Apps脚本自动生成的库文档

我目前正在开发Google Apps脚本库,该库基本上将电子表格视为数据库对象。

当前,该库具有两个相同的功能,例如

/**
* Opens and creates a query object for a spreadsheet with the given url.
*
* @param {String} the url of the spreadsheet
* @return {SpreadsheetQuery_} a spreadsheet query object for the given spreadsheet
*/
function openByUrl(url) {
    return new SpreadsheetQuery_(SpreadsheetApp.openByUrl(url));
}
Run Code Online (Sandbox Code Playgroud)

现在,对于这两个公共函数,生成的文档仅显示返回类型,而不显示参数或附带的说明。我假设这是一个Google问题,并没有真正打扰。

但是我的主要问题是,由于函数正在从私有函数实例化对象,因此如何获取自动文档以显示该对象上存在的方法。所有功能都将由对象提供,如果GAS可以在其上显示方法,那就太好了。

注意


这些方法都放在函数的原型上。例如。

SpreadsheetQuery_.prototype.from =函数(工作表){
    如果(_.isNumeric(sheet)){
        ....
}

谢谢。

documentation shared-libraries code-documentation intellisense-documentati google-apps-script

3
推荐指数
1
解决办法
1342
查看次数

氧分组

我对Doxygen中的页面和组有疑问。我有一个项目,在这里我将类与@defgroup和@ingroup cmds分组。到目前为止,这很好。

现在,我想为带有降价页面的项目添加特殊文档。这些页面应显示在专用模块(组)中。我试图用@page和@subpage cmds创建页面。效果很好,但是页面在菜单中显示为纯色。

因此,我尝试使用@ingroup将它们添加到组中。但这不起作用,正如我猜到的那样。是否可以将页面添加到模块(组)?

结果应如下所示:

Project
|-- Modules
| |-- "Module1"
| | |-- documentation page1 (from *.md file)
| | |-- class documentation
| |-- "Module2"
| | |-- documentation page2
| | |-- class documentation
Run Code Online (Sandbox Code Playgroud)

我希望你可以帮助我!

documentation doxygen

3
推荐指数
2
解决办法
1万
查看次数

如何为所有类方法添加常量字符串到__doc__?

我的代码看起来像这样:

constString = """
Default docstring info:
    1
    2
    3"""

class A():

    def A1():
        """
        First unique docstring.
        """
        pass

    def A2():
        """
        Second unique docstring.
        """
        pass
B = A()
print(B.A1.__doc__)
Run Code Online (Sandbox Code Playgroud)

如果我运行此代码,我会重新输出:

First unique docstring.

Second unique docstring.
Run Code Online (Sandbox Code Playgroud)

但是我想通过为类A中的所有方法添加constString来替换方法的docstring.输出必须如下所示:

First unique docstring.
Default docstring info:
1
2
3

Second unique docstring.
Default docstring info:
1
2
3
Run Code Online (Sandbox Code Playgroud)

我怎么能这样做?

python documentation docstring

3
推荐指数
1
解决办法
253
查看次数

Bootstrap 3.1文档 - 下载示例

我是Bootstrap的新手.经过一些初步的成功,我遇到了一个非常愚蠢的问题.

在getbootstrap.com的网站上有一些例子:

http://getbootstrap.com/getting-started/#examples

但我找不到下载它们的方法.你能帮我么?

我将衷心感谢您的帮助!

谢谢!

documentation twitter-bootstrap

3
推荐指数
1
解决办法
4938
查看次数

类似下划线的API文档

下划线作者是否使用任何特定工具来生成文档?我想是因为我发现至少有三个项目以相同的方式记录,但我找不到任何这些项目所使用的工具的任何信息.

javascript documentation backbone.js underscore.js

3
推荐指数
1
解决办法
315
查看次数

给doxygen @ref命名

我该如何命名Doxygen @ref标签?

我尝试了以下方法:

See @ref hello_world hello for more information
Run Code Online (Sandbox Code Playgroud)

输出以下内容:

See hello_world hello for more information
Run Code Online (Sandbox Code Playgroud)

hello_world链接到哪里hello_world。我正在寻找此输出:

See hello for more information
Run Code Online (Sandbox Code Playgroud)

hello链接到哪里hello_world。Doxygen的文档仅包含有关@ref\ref)的LaTeX形式的信息,并且我不知道如何将其应用于JavaDoc样式@ref

我将如何更改链接的“文本”值?

documentation syntax doxygen documentation-generation

3
推荐指数
1
解决办法
801
查看次数