问题标签 [documentation]

您使用哪些工具/网站来阅读 JavaDocs？

我目前使用 Firefox，在处理 J2EE 项目时打开了 20 多个选项卡，以获取所有可用的文档，这些文档不是很有用，占用了太多内存并且不可搜索。

我对这样一个工具/网站的期望：

• 聚合来自不同位置的 JavaDocs
• 直接访问 Eclipse 中的 Ctrl+T 等类型或类似类型
• 全文搜索
• 我选择的所有 Java 库之间的交叉引用
• 对于一个工具：离线支持
• 速度

不是强制性的：

• 注释事物的可能性
• 支持不同版本的库（+ diffing ？）
• IDE 集成

编辑：

感谢您的回答。我知道大多数网站，但又给了他们一次尝试。这是我的判断：

• 内置 Eclipse/IDE 功能
  • 紧密集成
  • 离线/在线支持
• javadoconline.com（不再维护）
  • 作品
  • 干净的外观
  • 在多个版本的 api 中查找匹配项并允许轻松切换
  • 简单但有效
  • 快速地
• jdocs（离线）
  • 看起来很精致
  • 有时很慢
  • 似乎缺少一些最新版本的库（Seam 2.0.0，Hibernate Validators），但看起来您可以自己添加它们
  • IDE 集成（未测试）
  • 每个项目的wiki风格评论
• docjar.com
  • 作品
  • 快速地
  • 混乱的用户界面
• javadoc_isearch
  • Firefox的greasemonkey脚本，使浏览javadocs更容易
  • 工作顺利，完美

我最近一直在研究 SQL2K8 中的报表定义自定义扩展 (RDCE)，但我一直找不到很多文档，甚至在 Internet 上都在谈论它。

MSDN有一个简要概述：http: //msdn.microsoft.com/en-us/library/cc281022.aspx

本书http://www.amazon.com/Applied-Microsoft-Server-Reporting-Services/dp/0976635313/ref=pd_bbs_sr_2?ie=UTF8&s=books&qid=1221629676&sr=8-2的示例报告是一些东西，但是我想知道是否有人对此有真正的经验，以及它是如何为他们工作的。如果有人有其他值得一看的参考资料，我将不胜感激。

我正在寻找更多更好的关于 Spring Web Flow 中的快照、流存储库和流状态序列化的文档。我发现的可用文档似乎很少。“Spring in Action”没有谈论这个。Spring Web Flow Reference Manual 确实在这里提到了几个标志：

http://static.springframework.org/spring-webflow/docs/2.0.x/reference/htmlsingle/spring-webflow-reference.html#tuning-flow-execution-repository

但并没有真正谈论为什么要更改这些设置、使用模式等。

有人有好的参考吗？

一个明显的答案是“内部维基”。用于软件文档的 wiki 的优缺点是什么？还有其他建议吗？你用什么来做你的软件文档？

Loren Segal - 不幸的是，我们不支持任何 doc 工具来从源代码注释中编译信息，但我同意这将是存储技术文档的最佳方式。我的问题是关于各种文档 - 从系统管理员类型到用户文档。

有没有人使用其他任何东西来记录他们的PHP代码PHPDoc? 是否有任何工具可以读取相同的文档语法但提供更丰富的输出？

在工作中，我们使用 Sandcastle 来创建帮助文件。我使用 SandCastleGUI 已经有一段时间了，我正在寻找一种在帮助文件中创建其他页面的方法。这些页面以称为 MAML 的 XML 格式编写。唯一的问题是我找不到适合这些文件格式的任何合适的编辑器。

我正在寻找一个所见即所得的编辑器来创建和编辑其他文档页面。

我找到了使用 flash 参数的指南，认为在此处发布可能很有用，因为 Flash CS3 缺少读取这些参数的用法示例。

查看链接的答案

我正在尝试使用 VS 2008 Express 版本，当我在关键字或类名上按 f1 时，我似乎在 90% 以上的时间都得到了“未找到信息”页面。

这是配置问题吗？是因为这是“免费啤酒”特快版吗？自我下载的版本以来，Microsoft 是否移动了他们的在线文档？

我有点惊讶，这是他们旗舰开发产品的演示，它似乎缺少几乎任何类型的集成参考文档。Visual Studio 中的集成帮助如何工作？

有没有办法在自动构建期间生成项目文档？

我想要一组带有用户手册的源文件（HTML？），并从中生成：

• PDF文件
• CHM 帮助
• HTML 版本的帮助

三种格式的内容基本相同。

目前我正在使用 msbuild 和 CCNET，但如果需要，我可以更改它。

我正在为我正在从事的项目寻找一个关于服务器端软件安装的好模板。

客户端非常简单。服务器端安装有点棘手。它由几个部分组成（服务、数据库连接、依赖项、需要畅通的端口等）。在最近的一次测试中，发现了几件未记录的碎片。现在，我需要为我们的灾难恢复计划和测试安装的方法创建安装文档，而不必使用“完整的”系统进行测试。

我真的很想建议我在哪里可以获得模板或此类文档的非常好的示例。我希望它是操作员可以在恢复的热度中阅读和理解的东西。

[编辑] 我们当前的文档主要来自我们的管理员在场外测试期间遇到的问题。在编写新代码时，我想确保提前编写文档。我一直在收集 VMWare 映像以开始测试，但一直在寻找一些好的示例。这是一家 Windows Server 商店（2000 和 2003 年）。Word 模板会很棒，但如果我能看到好的文档，我可以创建模板。关于应该测试什么的任何建议也很好。

[第二次编辑] 我从发布的答案中得到了几个好主意。改变我的谷歌搜索后，我想出了一些好的起点。它们并不完美，但它们是一个好的开始。

Microsoft Exchange - http://technet.microsoft.com/en-us/library/bb125074(EXCHG.65).aspx iPhone - http://manuals.info.apple.com/en_US/Enterprise_Deployment_Guide.pdf

http://www.novell.com/documentation/gwgateways/gw7_exch/index.html?page=/documentation/gwgateways/gw7_exch/data/ab32nt1.html http://cregan.wordpress.com/2006/06/22/ exchange-2003-step-by-step-installation-instructions/

http://technet.microsoft.com/en-us/magazine/cc160942.aspx

很好地涵盖了设计阶段的规划 - http://www.onlamp.com/pub/a/onlamp/2004/04/08/disaster_recovery.html?page=2

[编辑 10/29/2008]
这是我正在寻找的类型样本。它没有很多垃圾，但似乎足以解释为什么以及如何http://wiki.alfresco.com/wiki/Installing_Labs_3_Nile