我即将完成一个为期 9 个月的马拉松项目——一个包含超过 7 万行代码的 Web 应用程序。问题是我几乎不使用注释，从未使用过 javadoc，也从未保存任何类型的良好文档。 (噢，罪恶感!!:))
我现在需要专注于业务的非技术方面，并将这个庞然大物交给编程团队进行维护和新功能。那么我能做什么...最有用的注释/文档是什么？追溯文档的最佳策略是什么？ (有关于这个主题的书吗？)
PS。感谢您几个月来对 Stack Overflow 的帮助。一年前我几乎不懂 HTML。你让我度过了这一切!最佳答案
70K 行并不是那么大。它可能比您通常从事的项目要大，但至少不会大到一个人无法理解其中的大部分内容。这可能就是让你首先陷入麻烦的原因。浏览每个文件并写几句话来说明该类的作用并不会让您丧命。
如果没有对它的作用和原因进行某种解释，70K 行太大了，无法强加给某人或某个团队。怜悯你可怜的下属(并减少他们浪费在苦苦思索上的工时)，至少写一份路线图，详细解释项目的作用、项目的组织方式、哪些部分对性能或性能很重要。为了满足要求，哪些部分需要工作。如果您对该项目有任何书面要求，则应将其包括在内。
我想，在让您的团队处理这堆未记录的代码之前，您计划至少与团队成员坐下来一天，并向他们提供指导。写下您在培训期间想告诉他们的所有内容。在您真正与团队会面之前，请给团队该文件并一些时间阅读它。现在，您可以利用这一天与他们一起回答他们的问题来完善文档。确保答案包含在文档的下一个版本中。让您的团队的首要任务是解决您造成的问题。这将帮助他们为开始实现新功能做好准备。
在可预见的 future 能够回答团队的问题。创建某种系统来组织和保存您提供的信息。维基看起来很明显，但您还想确保新问题得到关注并快速得到解答。缺陷跟踪系统可以很好地发挥作用。像 SO 这样的问答格式也可以。
改变您对文档的态度。从错误中吸取教训，改变自己的方式，并鼓励/坚持人们花时间记录他们所做的事情。通过连接缺陷跟踪系统和版本控制系统，尝试使文档尽可能自动化。为您的员工提供制作有用文档所需的资源。安排专人负责文档。
关于php - 追溯记录+评论的策略，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/5440465/