2012-04-23 5 views
4

私は、各メソッドの後にコメントを持っているいくつかのコードは、例えばこれを言っている:メソッドのベストプラクティスの最後にコメントがありますか?

// End of contructor DbFactoryDBConnection() 

は、このようなコメントは、メソッドの終わりを示すために使用すべきかどうかを判断しますか?それは一般的な場所だった以前の雇用から拾われたものでした。

+5

個人的な意見であなたが終わるbracer何かコメント括弧の最後に追加Visual Studio用PowerCommandsを使用することができます。ウエッ、ありません。現代のIDEには構文と構造があり、これに対応しています。なぜ、価値を追加しないコメントでコードを汚染するのですか? – dash

+1

個人的意見:@ダッシュは言った。私が見ることができる理由は、メソッドが複数のスクリーンにまたがっている場合だけです。この場合、状況を改善するためにできるより良いことがあります。 –

+0

それは私の疑惑を確認しました。それらは削除されます。ありがとう。 – CSharpened

答えて

4

私は、このようなコメントは、ボディが1つの画面に収まらない方法の後であると感じています。これは、リファクタリングのための良い兆候であり、短くする方法や新しいエンティティ/サービス/ヘルパーを抽出するための長いメソッドを分割するための良い兆候だと私は信じています。これはC#領域のようなもので、非常に長いコードブロックを隠すために使用されることがあります。これはある種のGod Object anti-patterという記号です。

2

いいえ、中かっこがスクロールしていないかを知りたい場合は、ReSharperにすることができます。それは多くの点で素晴​​らしいです。

カーソルを中括弧の上に置くだけで、開いているものが表示されていない場合は、その前に行全体をヒントとして表示します。

1

私はこのようなコメントはまったく必要ではなく、コードを乱雑にしてくれると思います。ほとんどのIDE(Visual Studioなど)には、メソッドのスコープを長年にわたって強調表示する機能があるため、これを行うことでどのような価値をコードに追加できるのか分かりません。

0

いいえ、このようなコメントは使用しないでください。唯一の理由は、誰かがこのようなコメントを使用するということは、メソッドがの方法が長すぎるという事実です。しかし、現代のIDEは現状のあなたのどこかにあなたを見せてくれるだけでなく、折りたたみ方法を定義だけに戻すことさえできます。
このようなコメントは何の価値もなく、単純にコードベースを汚染します。

2

通常、この種のコメントは過度の手間です。
コメントが存在する適切な場所は、クラスとメソッドの冒頭と、コード内で重要な意思決定が行われる直前です。
IF、SWITCHまたはMETHODの終了を文書化する必要がある場合は、コードを再検討して簡略化する必要があります。

0

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

1

あなたはいつもそれが私はそれを使用すると、それは多くのことができます:)

関連する問題