标签: documentation

是否有关于WebForm_PostBackOptions的参数的文档？谷歌搜索我找不到任何东西.

我有一个包含多个文件的C程序,所以我有,例如,stuff.c它实现了一些函数,并stuff.h使用函数原型.

我该如何记录评论中的功能？

我应该在头文件中包含所有文档,文件中的所有文档.c,还是复制两者的文档？我喜欢后一种方法,但后来我遇到问题,我将更新其中一个文档而不是另一个(通常是我进行第一次修改的文件,即如果我先修改头文件,那么它的注释)将反映这一点,但如果我更新实施,只会更改那些评论).

这个问题及其答案也适用于C++代码 - 另请参阅我应该在哪里放置文档注释？

任何人都可以推荐一个程序来创建用户手册吗？不是标记语言(如LaTeX或DocBook),而是更像Scribus这样的交互式语言.因为我不是唯一一个会更新手册的人,软件应该是新手很容易接受的东西,但仍然有一些高级功能(比如从外部源/表中链接文本,处理主页/主题等) .

此致,奥斯卡

我记录了所有类,现在我想集成一个如何使用这些类的示例.我怎么做？

我想在C++中为新项目试用文档生成器.我认为我的选择是Doxygen或Sphinx.由于我有Python项目,我想使用Sphinx,我想知道Sphinx是否也是C++的正确选择.该狮身人面像的网站指出,支持C++,但是我找不到让我开始用C++文档的文档.

Stackoverflow上已经讨论过类似的问题,主要答案是:

尚未完全使用,
但继续观看

由于讨论已经超过一年了,我想知道这个结论是否仍然有效.我应该选择Doxygen而不是Sphinx作为我的C++文档吗？

如何将本地目录包含到Sphinx doc中？

我试过了

.. toc:: 

但这似乎没有任何影响:文档中没有插入任何内容.

基本上我需要链接到当前页面中的部分放置在每个页面的特定位置.

这可能吗？

说服别人评论他们的代码有什么好的理由？

我注意到许多程序员喜欢编写代码的速度,而没有评论而是为自己和其他人留下一些文档.当我试图说服他们时,我会听到一半被烘焙的东西,比如"方法/班级名称应该说它做什么"等等.你会怎么说他们改变主意？

如果您反对评论,请发表评论.对于试图说服人们评论代码的人来说,这应该是一种资源,而不是其他.:-)

其他相关问题是:评论代码,您是否评论您的代码以及您希望如何评论.

对于ActionScript 2,我使用过NaturalDocs.但是它对PHP的支持很差.到目前为止我看过doxygen和phpDocumentor,但是我认为它们的输出非常难看.有没有人有PHP自动文档生成的经验？我更喜欢能够使用javadoc风格的标签,它们很容易编写并且易于记忆.

在过去,我使用railsbrain.com提供了一个非常方便的离线api文档.

但他们停在版本2.3.2

有没有最新版本的其他解决方案.

我想在Python文档字符串的其他地方引用先前记录的函数参数.考虑以下(当然是完全人为的)示例:

def foo(bar):
    """Perform foo action
    :param bar: The bar parameter
    """

    def nested():
        """Some nested function that depends on enclosing scope's bar parameter.
        I'd like to reference function foo's bar parameter here
        with a link, is that possible?"""
        return bar * bar

    # ...
    return nested()

是否有一种使用Sphinx标记嵌入参数引用的简单方法,还是会自动发生？

(我是一个完整的Sphinx新手.我一直在扫描Sphinx文档,但没有找到这个问题的答案,或者是一个展示正确标记的例子.)