如何对没有文档的程序进行逆向工程

Question

我有一个python程序源,没有任何文档或注释.我确实尝试了两次以理解它,但大多数时候我都在失去赛道,因为有很多文件.应该完全快速地了解该计划的步骤.

Answer 1

迈克尔·费瑟斯的" 有效地使用传统代码 "是这种努力的极好起点 - 不是特别依赖于语言(他的例子是几种非python语言,但技术和思维方式可以很好地扩展到Python和几乎任何其他语言).

关键的重点是,您希望了解代码的原因 - 修改代码和/或移植代码.因此,使用电池和测试和跟踪/记录的脚手架来检测遗留代码是解决和安全负责地理解和修改的漫长而艰难的道路上的关键路径.

Feathers建议启发式和技巧,以便集中精力,以及如何在代码完全混乱(因此是"遗留")时开始 - 没有文档或误导性文档(描述一些完全不同的东西,可能是微妙的方式,来自于代码实际上是DOES),没有测试,不可测试 - 没有重构的意大利面依赖性纠结.这似乎是一个极端的例子,但任何在编程中度过长期职业生涯的人都知道它实际上比任何人都想要的更常见;-).

Answer 2

• 在过去,我使用'Python调用图'来理解源结构
• 使用调试器,例如pdb来唤醒代码.
• 尝试在休息一天后再次阅读代码,这也有帮助

Answer 3

我建议用epydoc http://epydoc.sourceforge.net/生成一些文档.当然,如果不存在docstring,结果将会很差,但它会为您提供至少一个应用程序视图,并且您可以更轻松地在类中导航.

然后,当您了解新内容然后再次重新生成文档时,您可以尝试自己编写文档.开始一些事情永远不会太晚.

我希望它有所帮助