我目前正在编写一份我刚刚撰写的程序的开发者文档，并且必须由其他人继续。 我使用Doxygen来记录我的代码，但是我希望显示一个更全局的视图，例如使用填充了函数名称和它们相互发送的参数的流程图。但我也必须代表事件，在我看来，流程图并不是最好的，或者至少我没有真正看到如何做到正确和明确。
所以我是对的吗？ 你需要继续开发已经启动的应用程序？有比流程图和UML更好的选择吗？
答案 0 :(得分：0)
作为一个拿起35,000行Java项目的人，有3条评论2其中“这是粗略的”和“yeesh”我可以说我想知道抽象基类是什么，程序的流程是什么是，并且定义了任何名称空间或全局变量。
对我来说真正有用的是一段或两段，它说“main”创建了一些基类的驱动程序，然后使用某些文件读取器读取xml文件，并在之前设置DefaultOutput类型的输出对象它执行driver.run（）函数，它将std：out流出到一个名为output.txt的文件，将std :: err运行到log.txt。
该段落可以节省我几个小时的代码，以便找出一直使用的内容。
对于任何可能出现的任何挑剔的代码而言，拥有“这取决于此，所以不要改变它或者你将毁掉所有东西”也是非常有帮助的。
答案 1 :(得分：0)
从一般的熟悉角度来看，我喜欢看到清晰详细的需求规范。根据我的经验，这在大多数情况下是缺乏的。
从设计的角度来看，我喜欢看到状态图用于状态转换， UML图用于一般代码结构和关系以及通信图，了解有关数据流的信息。
您可以提供的文档越多，下一个人就越好。但请记住，文档可能会很快过时，因此您的（好）代码注释和 doxygen输出可能（但不一定如此）比你写的任何东西都更新。