我的硕士论文主题是“未记录代码的生存以及如何维护它”

Question

我必须提交我的研究提案，我很困惑从哪里开始写我的提案。我应该在研究方法部分使用哪种类型的方法。是否有任何解决方案来维护未记录的代码？

Answer 1

听起来您可能想与处理未记录代码的人进行访谈/问卷调查。也许追踪源代码存储库中随着时间的推移发生的事情（有多少更改提交给有据可查的编码器库部分与未记录的那些？）。所以开源项目可能是一个好的开始。我曾在商业环境中工作过，其中许多编码器基本上没有文档记录，但可能很难找到愿意公开谈论这些示例的人，更不用说交出 repo 访问权限了。

关于解决方案，根据我的经验，任何未记录/记录不充分的代码都最好以极其防御性的方式进行维护（除非绝对必要，否则不要碰它）并随时添加文档。

还有一种观点认为，“代码就是文档”，但这只能在基础层面起作用，而且绝对不会超出某个复杂层，而且无论如何只能向您展示代码做而不是它应该做的（即，应该是什么错误和意外的副作用成为特性）。