标签: documentation

简短版本:我可以使用Normal包装模拟文件吗？statsroxygen

长版本:我正在开发一个软件包,并试图通过在一个标题下收集一些具有公共输入/参数的函数来使文档更具可读性,这将是对该组的通用引用.每个功能仍应独立地供最终用户使用.

我把文档作为灵感Normal,给出了许多与正态分布相关的方法,例如stats::dnorm().

当我搜索时,?dnorm我发现帮助部分的名称Normal即使Normal看起来不是导出的函数或对象.

我试过的是将以下内容放入funs.R:

##' @rdname funs
##' @name funs
##' @aliases sum1
##' @aliases prod1
##' @title Two functions
##' @param x X
##' @param y Y
##' @return sum1 returns x+y
##' \cr
##' prod1 returns x*y
##' @examples
##' sum1(3,4)
##' prod1(3,4)
##' @export
sum1 <- function(x,y) x+y
##' @export
##' @rdname funs
prod1 <- function(x,y) x*y

然后我继续 …

如何使用Sphinx-Napoleon为Google风格的文档字符串指示生成器的列表,可选参数和返回类型的类型？

我试过了

List[type]
list of type

Optional[type]
type, optional

和

Yields:
   type: 

分别; 但是所有产生的输出都不令人满意,与生成的文档的其余部分不一致.例如

Optional[type]

只是给

可选[类型]

没有任何链接type.

我尝试过每个内置主题并遇到同样的问题.

我应该如何使用Sphinx-Napoleon的Google风格文档来记录这些元素？

几年前,我们店里的每个人都对UML很疯狂.现在每个人似乎已经冷静下来了.

如果在软件项目中仍然广泛使用UML,我很好奇.

如果是这样,这种用法仅限于白板吗？你用它来做文件吗？您是否使用工具从中生成代码？

有关:

UML实用吗？

我最近发现了这个:http://php.net/get/php_manual_en.chm/from/a/mirror.它是一个.chm文件,其中包含您通常可以在其网站上找到的PHP的所有文档.方便离线使用.

我想知道,有没有人知道其他语言的类似事情.完整的离线文档,如果您暂时没有无线网络,可以使用.

对于C#,Visual Studio为您提供了下载和安装整个在线文档的选项,作为VS2008安装的一部分,因此如果您有Visual Studio 2008,那么您将获得C#离线文档.

编辑:如果您要说这是可能的,请发布超链接.

这就是我们现在拥有的:

• PHP:http://be.php.net/get/php_manual_en.chm/from/a/mirror
• Java:http://java.sun.com/javase/downloads/index.jsp#docs
• C:http://www.gnu.org/software/libc/manual/
• MS SQL服务器:http://www.microsoft.com/downloads/details.aspx？FamilyId = 765433F7-0983-4D7A-B628-0A98145BCB97
• Python 2.x:http://docs.python.org/download.html
• Python 3.x:http://docs.python.org/py3k/download.html
• Ruby:http://railsapi.com/
• Common Lisp HyperSpec:ftp://ftp.lispworks.com/pub/software_tools/reference/
• 完整的MSDN库:遗憾的是不再可用
• Visual Studio 2008 SP1脱机库:https://www.microsoft.com/downloads/en/details.aspx？FamilyID = 7BBE5EDA-5062-4EBB-83C7-D3C5FF92A373 &displaylang = en

我在哪里可以获得PDF版本的Android SDK文档和开发人员指南.看到一个安装sdk的帖子有html文档,我的没有.这是一个单独的下载.任何eclipse更新？谢谢

将逐项列表添加到roxygen2的适当语法是什么,例如,在@details部分？我可以创建一个乳胶列表环境吗？

似乎简单地忽略了换行符,即

#' @details text describing parameter inputs in more detail
#'
#' parameter 1: stuff
#' 
#' parameter 2: stuff

谢谢!

在Noda Time,我们使用Sandcastle和SHFB生成我们的文档.然后,我们将文档提交回源存储库 - 主要是因为这样可以轻松查看最新(和历史)文档.

我是该项目的主要开发人员,但我使用了两台计算机 - 不幸的是,他们正在构建不同的文档,即使它们都更新到同一个源.

这两台电脑在我能想到的每一个重要方面都是一样的:

• Sandcastle 2.7.2.0
• SHFB 1.9.6.0
• VS 2012专业版(均在"程序"中报告版本11.0.50727.1,在"关于"页面中均为"版本11.0.51106.01更新1")
• .NET Framework 4.5的本地帮助内容的最新版本(并且没有其他框架版本的本地帮助内容)

为确保清洁构建而采取的步骤:

• 删除了SHFB缓存文件夹(C:\Users\Jon\AppData\Local\EWSoftware\Sandcastle Help File Builder\Cache)
• 删除了生成文档的文件夹
• 删除了与SHFB项目文件相关的用户设置文件
• 删除了Visual Studio中的符号缓存

差异仍然存在.它们似乎仅限于从MSDN本身继承的文档Object.Finalize.

版本1(在机器"Chubby"上生成):

<div class="summary">Allows an object to try to free resources and perform
other cleanup operations before it is reclaimed by garbage collection.</div>

版本2(在机器"桑迪"上生成):

<div class="summary">Allows an <a 
   href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">
   Object</a> to attempt to free resources and perform other cleanup operations
   before the <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" 
   target="_blank">Object</a> is reclaimed …

我一直都喜欢Java API上的文档,但我知道有些人认为它们缺乏.所以我想知道,您认为API文档的一个很好的例子是什么？

请在任何答案中包含链接或实际示例.我希望有一些参考资料,我(以及其他人)当然可以用来改进我们自己的文档.

所以,我只知道如何使用Python,但我也知道如何在3d中建模.我听说过OpenGL,我真的想学习如何使用,因为它看起来非常有用(我想用它创建简单的游戏......).我找到了PyOpenGL,Op​​enGL的Python绑定,但我找不到任何"真正的"文档,所以唯一的选择是研究用C++或其他东西编写的代码示例和教程.但是,正如我所说,我只知道如何使用Python.我该怎么办？

我正在使用CheckStyle,FindBugs和PMD来验证我的Java代码.我已经修复了这些工具捕获的几乎所有错误.

我无法理解如何编写"包评论",这是checkstyle捕获的错误.我已经阅读了CheckStyle的文档,但我不明白.

有人可以帮助我在Java中编写包级别的注释吗？