不完全遵循项目 UML 图上的描述
Not exactly following what is depicted on project UML diagrams
这让我困惑了很长一段时间。我有一个已经完成的应用程序,但由于客户正在寻找它的详细文档,我现在必须创建图表。让我感到困惑的一点是,每当我制作图表时,图表似乎与我的编码看起来并不完全相同。
例如,在我的 class 图上,我有一个名为 'announcements' 的 class,在 class 下是一个 getAnnouncements() 方法。但在实际编码中,您永远找不到名为 getAnnoucements() 的方法,因为我选择不为其创建方法,而是将代码直接放在 main class 上。我知道这不是一个好的编码习惯,但如果呢?所以这些是我的问题:我真的必须遵循 class 图上的内容吗?或者因为我正在使用逆向工程,我是否必须按照我的代码中的内容制作图表?
如果您正在制作文档并且在代码级别制作 UML,请遵循代码中的实际内容。
这种方法的好处是
- 您确实有与您的代码相似的图表
- 您(和您的客户)将能够识别出部分糟糕的代码(即不遵循各种标准)——就像您描述的那样。它给了将来改进它的机会
缺点是您可能需要更正自动生成的图表。每次生成它。
这让我困惑了很长一段时间。我有一个已经完成的应用程序,但由于客户正在寻找它的详细文档,我现在必须创建图表。让我感到困惑的一点是,每当我制作图表时,图表似乎与我的编码看起来并不完全相同。 例如,在我的 class 图上,我有一个名为 'announcements' 的 class,在 class 下是一个 getAnnouncements() 方法。但在实际编码中,您永远找不到名为 getAnnoucements() 的方法,因为我选择不为其创建方法,而是将代码直接放在 main class 上。我知道这不是一个好的编码习惯,但如果呢?所以这些是我的问题:我真的必须遵循 class 图上的内容吗?或者因为我正在使用逆向工程,我是否必须按照我的代码中的内容制作图表?
如果您正在制作文档并且在代码级别制作 UML,请遵循代码中的实际内容。
这种方法的好处是
- 您确实有与您的代码相似的图表
- 您(和您的客户)将能够识别出部分糟糕的代码(即不遵循各种标准)——就像您描述的那样。它给了将来改进它的机会
缺点是您可能需要更正自动生成的图表。每次生成它。