重复维护 - 代码和文档

时间:2009-03-13 14:43:40

标签: c# java documentation maintenance

这可能不是最好的标题 - 如果有人在阅读我的问题后想出一个更好的标题,我将不胜感激。另外,我想预先说明我在互联网上大部分都是自学成才,因此可能会有很多我不知道的工具。

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

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

此外,我还有版本参考和(有时是部分)描述:

  • 我的网站(HTML)
  • my wiki
  • 的Javadoc

我的网站和SourceForge上还有一个绘图工具,它必须知道最新版本的FBP代码的Java版本。

一切都是相当彻底的交叉链接,但有时我会错过参考!几天前,我意识到我很长时间没有为我的项目更新SourceForge新闻,所以我不得不这样做:-)

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

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

欢迎任何想法。

2 个答案:

答案 0 :(得分:3)

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

  1. 构建
  2. 单元测试等
  3. 编译文档
  4. 部署构建
  5. 部署已编译的文档
  6. 否则你总是将追逐你的尾巴。显然,文档部署将需要不同的解决方案(例如复制到您的网站,FTP到其他地方等)。

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

    您看过/使用过doxygen了吗?这将处理您的多语言要求,并且已建立用于构建/维护文档。

答案 1 :(得分:0)

听起来您需要自动化构建/发布过程。我在O'Reilly上读了this article一段时间 - 看起来你们两个情况相似吗?他的解决方案大量使用Python,但至少,它可能会给你一些想法。