标签: documentation

伙计们,

研究和展示技术白皮书的最佳方法是什么？我不是指格式,概述,部分和类似的东西.

我从来没有写过 - 我想知道白皮书是否需要非常非常通用(概念)或具体(例如支持特定工具/方法)

如果你的回答有利于通用方法,我想知道如何研究它.是否更好地关注较小的用例场景,从小做起,使用特定的工具/方法,获得良好的理解,然后进行更多研究并开发关于该主题的广角视图？

我已经为我的公司继承了600多个运行内部网站的ColdFusion源代码文件.我的任务之一是"记录"它.代码库代表了大约5年的开发时间,并没有技术规范它的作用.

开发人员维护了每个文件的更改日志,并且有一致的标头.

我的想法是,我可以构建各种模块的依赖关系图并引用存储过程,以便通过扫描源文件来简化此文档.我过去使用过Doxygen来获取c ++源代码,我想知道ColdFusion是否存在这样的工具.

我正在研究的一个输出是创建xmind文件的能力,作为可视化模块相互关系中的交叉依赖关系的手段.

提前致谢,

克里斯

NUnit的模拟库NUnit.Mocks的文档在哪里？

我在他们的官方文档或维基中找不到任何内容.

所以我已经定义了一些vars来保存我的clojure代码中的状态数据.我刚刚发现我可以为这些变量添加文档字符串,例如:

(def ^{:doc "Documentation for *my-var*"}
        *my-var*)

那让我打电话(doc *my-var*)给REPL.这似乎是一个有效且有用的事情,但它似乎并不像我读过的(有限的)代码中的常见做法.

这被认为是惯用语吗？

我有一个django项目,我在docstrings中使用reST来记录以下内容:

1. 在IDE中帮助diagloags
2. 稍后使用Sphinx构建HTML文档

我的文档在IDE(PyCharm)中正确显示,但我无法配置Sphinx为我生成HTML文档.

这是我的项目的结构

+--------------------------------------------+
|  /saassapp         # django project path   |
|     /docs          # dir for sphinx        |
|        conf.py     # sphinx config file    |
|        ...                                 |
|     settings.py    # django settings       |
|     /studyview     # django app            |
|        ...
|     ...                                    |
+--------------------------------------------+

有任何想法吗？对conf.py文件的检查非常有用.谢谢.

编辑

我的项目名称是saassapp,我试图制作文档的模块叫做studyview.

• Sphinx conf.py文件:http://pastebin.com/HTYdc1rR
• Sphinx index文件:http://pastebin.com/bu1r38TQ
• 结果make html:http://pastebin.com/MWJj94EE

是否有关于如何/在何处指定应用程序版本号的约定？

例如,对于ruby gems lib/mygem/version.rb,通常用于此目的的文件.

我的猜测是创建这样的config/version.rb文件:

module MySite
  VERSION = "0.0.4"

  # or in MySite::Application class
  # 
  # class Application
  #   VERSION = "0.0.4"
  # end
end

我试图找出python中所有异常类的母亲带来哪些方法和属性:Exception类.但是,由于官方文档似乎没有提供它,我遇到了一些麻烦.

我能找到的最好的是:http://docs.python.org/library/exceptions.html但只列出了内置的异常.

这是怎么回事？我已经习惯了Java和PHP文档,其中所有内容都放在桌子上:(

我试着在我的代码中为一些样式添加文档.问题是,android studio没有将文档直接链接到样式的用法.

我的意思是,简单的<! - Docu - >注释不会为样式创建我想要的文档.

<!-- Documentation -->
<style name="graph" parent="font_graph_base"/>

这是我想要的,作为视图属性的示例:

这就是我得到的,如果我使用简单的<! - - >注释,我想要的是填写此文档.

有没有办法让这个工作？

我想用Sphinx记录Python对象属性.我明白我应该用

:ivar varname: description
:ivar type varname: description

但是我看到了一个奇怪的行为,那就是Sphinx在我的项目中搜索变量名并尝试创建符号链接.例如这段代码:

class A(object):
    """
    :ivar x: some description
    """
    def __init__(self, x):
        self.x = x

class B(object):
    def x(self):
        return 1

class C(object):
    def x(self):
        return 2

会导致此错误:

mylibrary.module1.A的module1.py:docstring:无:警告:找到多个目标为交叉引用u'x':mylibrary.module1.Cx,mylibrary.module1.Bx

我是否错误地理解了:ivar的目的或用法？

我正在写一个R包,我正在用roxygen2记录我的所有函数.但是,我不希望所有功能都出现在软件包的手册中.如何指定应在包装手册中显示哪些功能,或哪些不应该？

我知道用一个前导点命名一个函数,例如,.f <- function()而不是f <- function()一个解决方案.还有其他解决方案吗？