4

たとえば、各メソッドの後にコメントがあるコードがいくつかあります。

// End of contructor DbFactoryDBConnection()

メソッドの終わりを示すためにこのようなコメントを使用する必要がありますか? それは、それが当たり前だった以前の仕事から拾ったものでした。

4

7 に答える 7

4

このようなコメントは、ボディが 1 つの画面に収まらないメソッドの後にあるように感じます。これは、そのような長いメソッドをリファクタリングして分割し、メソッドを短縮したり、新しいエンティティ/サービス/ヘルパーを抽出したりするための良い兆候だと思います. これは C#リージョンのようなもので、非常に長いコード ブロックを非表示にするために使用されることがあります。

于 2012-04-23T09:44:00.067 に答える
2

通常、この種のコメントは過剰な文書化の問題です。
コメントを配置する適切な場所は、クラスとメソッドの先頭で、コード内で重要な決定が行われる直前です。
IF、SWITCH、または METHOD の終わりを文書化する必要がある場合は、コードを単純化するために再検討する必要がある可能性が非常に高くなります。

于 2012-04-23T09:45:07.037 に答える
2

いいえ。スクロールせずに中括弧が閉じているものを知りたい場合は、ReSharperを使用できます。これは多くの点で素晴​​らしいです。

中かっこにカーソルを置くだけで、中かっこの開始点が表示されていない場合は、その前の行全体にツールチップが表示されます。

于 2012-04-23T09:43:26.137 に答える
1

Visual Studio の PowerCommands をいつでも使用できます。中かっこの最後にコメントを追加します。私はそれを使用しており、非常に役立ちます:)

于 2012-04-23T09:50:42.247 に答える
1

この種のコメントは完全に不要であり、コードを混乱させるだけだと思います。ほとんどの IDE (Visual Studio など) には、メソッドのスコープ (または何でも) を強調表示する機能が長年にわたって備わっているため、これを行うことでコードにどのような価値を追加できるかわかりません。

于 2012-04-23T09:44:14.643 に答える
0

これはソース IMHO には属しません。有効なソース コード ブロックとの同期が簡単に外れてしまいます。Visual Studio でこの情報を表示する拡張機能があります。これが役立つと思います。

于 2012-04-23T09:46:38.307 に答える
0

いいえ、そのようなコメントは使用しないでください。誰かがこのようなコメントを使用する唯一の理由は、メソッドが長すぎるという事実です。しかし、それにもかかわらず、最新の IDE では、現在どのメソッドにいるかが示され、メソッドを単に定義に戻すことさえできます。
このようなコメントは何の価値もなく、コードベースを汚染するだけです。

于 2012-04-23T09:44:37.030 に答える