c# - 重复维护 - 代码和文档

Question

关闭。这个问题不满足Stack Overflow guidelines .它目前不接受答案。












想改善这个问题吗？更新问题，使其成为 on-topic对于堆栈溢出。

3年前关闭。




Improve this question




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

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

我的网站

SourceForge 文件发布系统(zip 文件或 jar 文件)

SourceForge SVN

此外，我有关于以下方面的版本引用和(有时是部分)描述:

我的网站 (HTML)

我的维基

Javadoc

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

一切都非常彻底地交叉链接，但有时我会错过引用!几天前，我意识到我已经很长时间没有为我的项目更新 SourceForge 新闻了，所以我不得不匆匆忙忙地这样做:-)

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

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

欢迎任何想法。

Answer 1

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

构建

单元测试等

编译文档

部署构建

部署编译文档

否则你总是会追着你的尾部。显然，文档部署将需要不同的解决方案(例如复制到您的网站、FTP 传输到其他地方等)

我不确定是否有解决所有这些问题的 Elixir 。我在属性文件/配置文件中维护版本号，并进行适当的搜索/替换。代码文档尽可能包含在代码本身中，然后在我的构建中进行预处理(上面的第 3 步)。

你见过/用过doxygen ?这将处理您的多语言需求，并且非常适合构建/维护文档。