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

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

我正在维护在Java和C#中实现基于流的编程(FBP)概念的软件.对于这些,我都有以下代码：

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

另外,我在以下方面有版本参考和(有时是部分)描述：

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

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

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

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

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

任何想法都将受到欢迎.

解决方法:

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

>建立
>单元测试等
>编译文件
>部署构建
>部署编译的文档

否则,您总是会追逐自己的尾巴.显然,文档部署将需要不同的解决方案(例如,复制到您的网站,通过FTP传输到其他位置等)

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

您看过/使用过doxygen吗？这将满足您的多语言要求,并且对于构建/维护文档已经建立了良好的基础.

标签：maintenance,java,c,documentation
来源： https://codeday.me/bug/20191210/2103419.html