标签: code-documentation

您好,我想开始在Apples Swift语言上运行一些微基准测试.但是我觉得很难找到关于编译器优化的不同选项的适当文档.

我已经阅读了很多关于该语言的其他人的微基准测试的问题和文章,但是有一些关于这个主题的确切文档会很好.

在最新的测试版中,使用的似乎是:

- 没有优化

-O 安全优化？

-Ounchecked(替换-Ofast)不安全的优化,(不检查整数溢出,数组越界等)

我的问题是,这些都是我可能的选择吗？有没有人有一些资料记录这个？

编辑: 我已经找到类似的文件与我需要的目标-c与gcc在这里:https: //gcc.gnu.org/onlinedocs/gcc-2.95.3/gcc_2.html第2.8节.这就是我对Swift的需求..

我希望能够将模板化的YARD doc样式注释插入到我现有的Rails遗留应用程序中.目前它几乎没有评论.我希望类标题和方法标题具有指定的参数(通过从我假设的方法签名中提取)和占位符的返回值.

在PHP代码中,我有一些工具可以检查代码并在适当的位置创建插入代码中的doc头注释.在Ruby with Duck类型等中,我确信像@params等类型之类的东西不容易猜到,而且我很好 - 我希望在插入后手动逐个查看代码文件.如果可能的话,只想避免必须将所有骨架模板插入代码(超过500个文件).

我已经搜索过这样做的宝石等,到目前为止还没有找到过.那里有没有？

我的意思是：

• TLDR： 如何让我的软件包帮助包括所有基础文档字符串？
• 我已经创建了一个包。该软件包具有所有正确的__init__.py文件和所有正确的文档字符串（模块，函数，类和方法级文档字符串）。但是，当我执行时help(mypackage)，提供的唯一帮助是该顶级__init__.py模块提供的帮助。

通常，包级的帮助并不包括所有基础文档字符串的，但有时它。

我想确保我嵌入了所有基础文档字符串。

例如，在numpy软件包中，即使未在顶级提供，所有基本文档字符串也可在命令提示符的帮助中找到__init__.py。

即我可以输入

>>> help(numpy)

并查看所有文档，包括在dunder init模块外部定义的文档。

但是，许多其他软件包，包括诸如pandas软件包之类的流行软件包，并未捕获所有基础文档。

即输入

>>> help(pandas)

仅向我提供中定义的文档__init__.py。

我想创建镜像的软件包级文档numpy。

我试着numpy浏览一下它是如何执行此魔术的，没有运气。我已经执行过Google搜索，但似乎无法用短语表达此问题并获得任何正当的链接。

Mozilla在线文档很棒,但有时我没有互联网连接和o'reilly javascript权威指南中的参考也很棒,但缺乏方便的搜索功能.

我只是想知道是否有像railsapi,或yard或jQAPI这样的javascript

尝试安装PHPDocumentor与PEAR安装后没有成功,我尝试手动,如官方网站上详细说明:http://www.phpdoc.org/docs/latest/for-users/installation.html

我下载了文件并在/ usr/bin /上创建别名但是当我尝试通过终端y执行phpdoc.php时它显示错误.

这是我尝试的:

> cd /usr/bin/
> ./phpdoc.php

这是错误:

PHP Warning:  include_once(/Applications/MAMP/htdocs/phpdocumentor/src/phpDocumentor/../../vendor/autoload.php): failed to open stream: No such file or directory in /Applications/MAMP/htdocs/phpdocumentor/src/phpDocumentor/Bootstrap.php on line 72
PHP Warning:  include_once(): Failed opening '/Applications/MAMP/htdocs/phpdocumentor/src/phpDocumentor/../../vendor/autoload.php' for inclusion (include_path='/Applications/MAMP/bin/php/php5.3.6/lib/php/:/Applications/MAMP/bin/php/php5.3.6/lib/bin/') in /Applications/MAMP/htdocs/phpdocumentor/src/phpDocumentor/Bootstrap.php on line 72
PHP Fatal error:  Class 'phpDocumentor_Task_Runner' not found in /Applications/MAMP/htdocs/phpdocumentor/bin/phpdoc.php on line 37

我正在使用Mac Os X,正如您所看到的,我使用MAMP来运行Apache.这里发生了什么？为什么它试图打开一个不存在的文件？(因为它在PHPDocumentor文件夹中确实不存在)

谢谢.

我真的想为一个视图创建一个评论,并简要描述其目的.不幸的是,无法在oracle中为视图创建注释.此功能仅适用于表,列和物化视图.我想知道你是如何描述数据库视图的？

希望通过使用命名元组来保存多个变量以通过多个函数来清理一些代码。下面是一个简化的例子（我实际上还有一些额外的参数）。

前：

def my_function(session_cass, session_solr, session_mysql, some_var, another):
"""Blah blah.

Args:
    session_cass (Session): Cassandra session to execute queries with.
    session_solr (SolrConnection): Solr connection to execute requests with.
    session_mysql (connection): MySQL connection to execute queries with.
    some_var (str): Yada yada.
    another (int): Yada yada.
"""

后：

def my_function(sessions, some_var, another):
"""Blah blah.

Args:
    sessions (namedtuple): Holds all the database sessions.
    some_var (str): Yada yada.
    another (int): Yada yada.
"""

对于文档字符串，我一直在遵循 Google 样式指南，并添加了类型（受这篇文章的启发），我非常喜欢它，因为它可以更轻松地跟踪传入的类型。

我的问题是，在这种情况下，您将如何记录命名元组？显然，由于它当前已设置，因此您没有关于 namedtuple 中的类型的信息。是否有一种可接受的方法可以在此处扩展文档字符串，或者记录定义它的命名元组（未显示）？

我知道你可以在这个庄园里记录一个类，但我试图远离使用一个类，因为除了保存变量之外，我真的没有任何目的。

我是Kotlin和Dokka的新手。在Wiki和教程之后，我尝试使用gradle构建文件中的以下几行来为dokka文档工具设置项目：

在项目gradle文件中：

classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:0.9.15"

在模块gradle文件中：

apply plugin: 'org.jetbrains.dokka-android' 

Android studio版本是2.3.3

同步后，项目重建和Android Studio重新启动后，我预计dokka任务会出现在“工具” /“任务和上下文” /“ +打开任务”中，但我看不到任何任务。

我想念/做错了什么？

先感谢您

给出以下代码：

/// <summary>
/// Implementations represent a configuration with a specific data 
/// type <see cref="T"/> that can be used by this application.
/// </summary>
internal interface IConfiguration<T>
{
}

我得到一个编译器警告CS1723在T内部see crefXML元素：

XML注释具有引用类型参数的cref属性“ T”

在这种情况下，MS Docs完全没有用。我为什么要关心这个警告？是什么原因呢？

我试图用现有的compodoc文档添加其他侧面导航菜单。

我可以像下面这样。

menu-wc.js

<li class="link">
    <a href="dependencies.html" data-type="chapter-link">
       <span class="icon ion-ios-list"></span>Custom Change
    </a>
</li>

当我们使用此npm命令更新文档时

compodoc -p src/tsconfig.app.json

更改已消失。每次执行此命令时，都会重新创建main-wc.js文件。

有什么方法可以自定义compodoc文档？