2016-08-06 4 views
0

これはかなりの間私を混乱させています。私はすでに完了しているアプリを持っていますが、クライアントが詳細なドキュメントを探しているので、今度は図を作成する必要があります。私が混乱しているのは、私がダイアグラムを作成するたびに、ダイアグラムがコーディングの見た目とまったく同じではないように見えることです。 たとえば、私のクラスダイアグラムでは、「アナウンス」というクラスがあり、そのクラスの下にgetAnnouncements()メソッドがあります。しかし実際のコーディングでは、getAnnoucements()というメソッドを見つけられることはありません。なぜなら、そのメソッドを作成せず、コードを直接メインクラスに置くからです。私はそれが良いコーディング練習ではないことを知っていますが、もしあれば?だから私の質問です:私は本当にクラス図にあるものに従わなければなりませんか?あるいは、リバースエンジニアリングを使用しているので、自分のコードに従ってダイアグラムを作成する必要がありますか?プロジェクトUMLダイアグラムに描かれているものに正確に従っていない

+0

あなたの説明に完全に従うことはできません。コード例を追加できますか? –

+0

@ThomasKilian私はリバースエンジニアリングを使用しているので、私はちょうどこれを置くことができます、私はすでに作ったコード上にあるものを正確に基にせずに図を作ることができますか?私は私の図を読者にできるだけ分かりやすくしようとしています。自分のコードクラスに基づいているなら、それを読んだ人は誰でも混乱するかもしれません。 – Glen

+0

私はあなたのコードもオブジェクト指向プログラミングにもアプローチしていませんが、最高のトレーニングの1つで、私はそういうことを聞いてきました(そして私はそれに完全に同意します)。 "クラスコードを構築するときにまずやることはすべての属性にゲッターとセッターを生成する - あなたはオブジェクト指向のアプローチに従わない "。もちろん、ほとんどの場合、属性にアクセスするクラス外のメソッドを使用する方がさらに悪いです。 – Ister

答えて

0

ドキュメントを作成していて、コードレベルでUMLを作成する場合は、実際にコードに含まれているものに従ってください。

このアプローチの利点は

  • は、あなたが本当にあなたのコードに似た図を持っていることになります
  • あなた(とあなたのクライアントは)貧困層のコードの一部を認識することができるようになります(つまり、様々な規格に従っていません) - あなたが描いているもののように。将来的に改善するチャンスを与えます。

自動生成された図を修正する必要があるかもしれないという欠点があります。あなたがそれを生成するたびに。

関連する問題