3

这可能不是最好的标题 - 如果有人在阅读我的问题后能提出一个更好的标题，我将不胜感激。另外，我想提前说一下，我主要是在互联网上自学的，所以可能有很多我不知道的工具。

我正在维护在 Java 和 C# 中实现基于流的编程 (FBP) 概念的软件。对于其中的每一个，我都有以下代码：

  • 我的网站
  • SourceForge 文件发布系统（zip 文件或 jar 文件）
  • SourceForge SVN

此外，我有版本参考和（有时是部分）描述：

  • 我的网站 (HTML)
  • 我的维基
  • Javadoc

还有一个绘图工具，也在我的网站和 SourceForge 上，它必须了解最新版本的 Java 版本的 FBP 代码。

一切都非常彻底地交叉链接，但有时我会错过参考！几天前，我意识到我已经很长时间没有为我的项目更新 SourceForge News 了，所以我不得不忙着去做 :-)

我意识到其中一些车辆可能是多余的，但一般来说，我不知道谁在看什么。

所以我的问题是是否有办法减少所有这些开销，例如 HTML“嵌入”功能会很好，所以我至少可以将最新版本号存储在一个地方。我可能可以简化 Java 交叉引用，但我猜跨语言会更好，但不太可能。

任何想法都会受到欢迎。

4

2 回答 2

3

在我看来，您希望在构建/部署过程中更新和维护您的文档，例如

  1. 建造
  2. 单元测试等
  3. 编译文档
  4. 部署构建
  5. 部署编译的文档

否则你总是会追着你的尾巴。显然，文档部署将需要不同的解决方案来确定它的去向（例如复制到您的网站、通过 FTP 传输到其他地方等）

我不确定这一切是否有灵丹妙药。我在属性文件/配置文件中维护版本号，并进行适当的搜索/替换。代码文档尽可能放在代码本身中，然后在我的构建中进行预处理（上面的第 3 步）。

你见过/使用过doxygen吗？这将处理您的多语言要求，并且在构建/维护文档方面非常成熟。

于 2009-03-13T15:06:59.800 回答
0

听起来您需要自动化构建/发布过程。不久前我在 O'Reilly 上阅读了这篇文章- 看来你们俩的情况很相似？他的解决方案大量使用了 Python，但至少它可能会给你一些想法。

于 2009-03-13T15:16:21.057 回答