Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/ssis/2.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Documentation 我的硕士论文题目是;&;“如何维护它”;_Documentation_Code Documentation - Fatal编程技术网

Documentation 我的硕士论文题目是;&;“如何维护它”;

Documentation 我的硕士论文题目是;&;“如何维护它”;,documentation,code-documentation,Documentation,Code Documentation,我必须提交我的研究提案,我很困惑从哪里开始写我的提案。我应该在研究方法部分使用哪种类型的方法。有什么办法可以维护未记录的代码吗?听起来你可能想与处理未记录代码的人进行访谈/问卷调查。也许可以跟踪源代码存储库中随着时间的推移发生了什么(与未记录的代码库相比,代码库中有多少更改被提交给了有文档记录的部分?)。因此,开源项目可能是一个良好的开端。我曾在商业环境中工作过,在那里许多编码人员基本上没有文档记录,但可能很难找到愿意公开谈论这些示例的人,更不用说交出回购访问权了 关于解决方案,根据我的经验,任

我必须提交我的研究提案,我很困惑从哪里开始写我的提案。我应该在研究方法部分使用哪种类型的方法。有什么办法可以维护未记录的代码吗?

听起来你可能想与处理未记录代码的人进行访谈/问卷调查。也许可以跟踪源代码存储库中随着时间的推移发生了什么(与未记录的代码库相比,代码库中有多少更改被提交给了有文档记录的部分?)。因此,开源项目可能是一个良好的开端。我曾在商业环境中工作过,在那里许多编码人员基本上没有文档记录,但可能很难找到愿意公开谈论这些示例的人,更不用说交出回购访问权了

关于解决方案,根据我的经验,任何没有文档记录/文档记录不良的代码最好是以非常防御的方式进行维护(除非您必须这样做,否则不要触摸它),并在运行时添加文档


还有一种观点认为“代码就是文档”,但它只在基本层面上起作用,绝对不会超出某个复杂层次,而且在任何情况下,它只向您展示代码的功能,而不是它应该做什么(即什么应该是bug和意外副作用成为特性).

您的第一个问题与编程无关。第二个是你应该通过研究来回答的问题。