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

C# 重复维护-代码和文档,c#,java,documentation,maintenance,C#,Java,Documentation,Maintenance,这可能不是最好的标题——如果有人在读了我的问题后能想出一个更好的标题,我将不胜感激。另外,我想说的是,我在互联网上基本上是自学成才的,所以可能有很多工具我都不知道 我正在维护用Java和C实现基于流编程(FBP)概念的软件。对于其中的每一项,我都有以下代码: 我的网站 SourceForge文件发布系统(zip文件或jar文件) SourceForge SVN 此外,我有以下方面的版本参考和(有时是部分)说明: 我的网站(HTML) 我的维基 Javadoc 还有一个绘图工具,也在我的网

这可能不是最好的标题——如果有人在读了我的问题后能想出一个更好的标题,我将不胜感激。另外,我想说的是,我在互联网上基本上是自学成才的,所以可能有很多工具我都不知道

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

  • 我的网站
  • SourceForge文件发布系统(zip文件或jar文件)
  • SourceForge SVN
此外,我有以下方面的版本参考和(有时是部分)说明:

  • 我的网站(HTML)
  • 我的维基
  • Javadoc
还有一个绘图工具,也在我的网站和SourceForge上,它必须知道FBP代码的Java版本的最新版本

每件事都是相互关联的,但有时我会错过一个参考!几天前,我意识到我已经很久没有为我的项目更新SourceForge新闻了,所以我不得不赶紧这么做:-)

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

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


欢迎提出任何想法。

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

  • 建造
  • 单元测试等
  • 编制文件
  • 部署构建
  • 部署已编译的文档
  • 否则你总是在追你的尾巴。显然,文档部署将需要不同的解决方案(例如复制到您的网站、FTPed其他地方等)

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


    你见过/用过吗?这将处理您的多语言需求,并且是构建/维护文档的良好工具。

    听起来您需要自动化构建/发布过程。我在奥雷利上读了一段时间——你们俩的情况似乎很相似?他的解决方案大量使用Python,但至少可以给您一些想法。

    这确实是一个有问题的问题,希望有灵丹妙药解决这类问题有一个建议,您不需要再使用SourceForge,因为GitHub允许您进行二进制发布。此外,您可能希望包含指向您正在谈论的各种资源的链接,以便我们了解您的问题有多严重。