1

私は本当にこのルールのポイントが何であるかを理解したいと思っています. コンストラクターが「クラスの新しいインスタンスを初期化する」ことは明らかではありませんか?

メソッドの要約に「これはメソッドであり、何かを実行し、値を返す可能性があります」と強制するのと同じように感じます

4

1 に答える 1

2

IMO、これは主にコンストラクターの要約の一貫性に関するものであり、特定のコンストラクターの要約の表現ではありません。コンストラクターに要約を含める必要があるが、一貫性のある表現をチェックしない場合は、さまざまなスタイルの説明になります。これはまさに世界の終わりではありませんが、APIユーザーを悩ませるようなものです。

ルールを有効にしておく理由があり、標準のコンストラクターの要約を生成する簡単な方法が必要な場合は、GhostDocを参照してください。

于 2012-07-23T12:32:39.980 に答える