我目前正在为我刚刚编写的程序编写开发人员文档，必须由其他人继续编写。我正在使用氧气记录我的代码，但我想显示一个更全局的视图，例如使用流程图填充函数的名称和它们相互发送的参数。但我也必须表示事件，在我看来，流程图似乎不是最好的，或者至少我真的不知道如何做得正确和清晰。
所以我说的对吗?您需要什么来跟上已经启动的应用程序的开发?有比流程图和UML更好的选择吗?
从一般熟悉的角度来看，我喜欢看到清晰和详细的需求规格说明。根据我的经验，这在大多数情况下是缺乏的。
从设计的角度来看，我喜欢看到状态图用于状态转换，UML图用于一般代码结构和关系，通信图用于数据流信息。
你能提供的文档越多，对下一个的人来说就越好。但是请记住，文档可能很快就会过时，因此您的(好的)代码注释和氧输出可能(但不一定如此)比您编写的任何其他内容都要更新。
作为一个拿起35000行Java项目的人，其中有3条评论，其中2条是"这太恶心了"one_answers"是的"，我可以说我想知道抽象基类是什么，程序的流程是什么，以及定义的任何名称空间或全局变量。
真正对我有帮助的是一段或两段，沿着"main创建一些基类的驱动程序，然后使用一些文件阅读器读取xml文件，并在执行driver.run()函数之前设置一个类型为DefaultOutput的输出对象，该函数将std:out流到一个名为output.txt的文件，并将std::err流到log.txt。
这段话可以节省我在你的代码中找出什么一直在使用的时间。
对于可能出现的任何挑剔的代码，有一个"这取决于这个，所以不要改变它，否则你会破坏一切"的提示也是非常有用的。