Documentation 如何使参考文档保持最新？
为了好玩和好玩，我正在做另一个PHP框架，我正在做第一轮文档。我计划编写一点代码，记录我编写的代码，再编写一些代码，调整文档以反映代码的新功能，重复。例如，目前的配置非常手动且繁琐，但我正在记录它，因为它需要像今天一样进行配置。一旦我实现了设置的自动化，我计划重写这些部分，以反映当前状态Documentation 如何使参考文档保持最新？,documentation,maintenance,Documentation,Maintenance,为了好玩和好玩，我正在做另一个PHP框架，我正在做第一轮文档。我计划编写一点代码，记录我编写的代码，再编写一些代码，调整文档以反映代码的新功能，重复。例如，目前的配置非常手动且繁琐，但我正在记录它，因为它需要像今天一样进行配置。一旦我实现了设置的自动化，我计划重写这些部分，以反映当前状态 我想知道的是，有没有什么方法可以让参考文档保持最新？我所说的不仅仅是记录API（PHPDoc等免费提供），还有更大的方案；教程，概述文章，一切。有什么好方法可以最大限度地减少忘记更新特殊内容的机会吗？这是一个非
我想知道的是，有没有什么方法可以让参考文档保持最新？我所说的不仅仅是记录API（PHPDoc等免费提供），还有更大的方案；教程，概述文章，一切。有什么好方法可以最大限度地减少忘记更新特殊内容的机会吗？这是一个非常困难的问题，因为非定域化：一个文档元素中的信息可能依赖或影响多个代码位置，当您查看代码位置时，通常不知道文档。因此，代码的更改可能不会触发文档的更新，即使用户愿意这样做 我认为在每个代码部分中包含某种形式的显式链接是很重要的，在这些代码部分中，更改将触发文档中的更改。让人们更新文本是一项艰巨的任务，因此让他们找到可能受影响的区域是很困难的，尤其是对于更一般的材料（例如API）
如果我正在更新一个在多个地方提到的功能，我需要该列表至少知道在哪里寻找可能需要更新的功能 这是一个非常困难的问题，因为非本地化：一个文档元素中的信息可能依赖或影响多个代码位置，当您查看代码位置时，通常不知道文档。因此，代码的更改可能不会触发文档的更新，即使用户愿意这样做 我认为在每个代码部分中包含某种形式的显式链接是很重要的，在这些代码部分中，更改将触发文档中的更改。让人们更新文本是一项艰巨的任务，因此让他们找到可能受影响的区域是很困难的，尤其是对于更一般的材料（例如API）
如果我正在更新一个在多个地方提到的功能，我需要该列表至少知道在哪里寻找可能需要更新的功能 在我的第一份工作中，我们做了类似的事情
/*
<document>
<version>x.y.z.g</version>
<date>10.4.2009</version>
<key>fff#ggg</key>
<more...................../more>
</socument>
*/
int ggg(char x){
...
...
}
/*
x、 y.z.g
10.4.2009
fff#ggg
*/
int ggg（字符x）{
...
...
}
在PHP中，构建扫描代码注释的东西应该不会太难，如果它们以一种预先知道的、方便的格式保存的话。我们在我的第一份工作中也做过类似的事情
/*
<document>
<version>x.y.z.g</version>
<date>10.4.2009</version>
<key>fff#ggg</key>
<more...................../more>
</socument>
*/
int ggg(char x){
...
...
}
/*
x、 y.z.g
10.4.2009
fff#ggg
*/
int ggg（字符x）{
...
...
}