2009-06-05 7 views
5

私は、機械で生成されたコメントや機械で生成された領域がかなりあります。C#からロボコメントと#regionを取り除く方法は?

#region methods 
/// <summary> 
/// Implementation of a public method foo bar, returning a void 
/// </summary> 
/// <param name="value">A string parameter named value input</param> 
public void fooBar(string valueInput) 
{ 

} 
#endregion 

コメントを剥離するためReSharperののプラグインや機能があります:

これらは、もっぱらパスカル同棲名前のメソッドメタデータと空間拡張を繰り返しコメントしている(または特に誤解開発者が作成) #regionタグは一括して表示されますか?

答えて

4

なぜ正規表現を使用しないのですか?&はVisual Studioで置き換えますか?地域タグの場合

 ///.* 

 [#]region.* 
    [#]endregion 
+0

完璧に動作します、ありがとう! – MatthewMartin

1

これらの部品は、おそらく手に型指定された:戻って、パブリックメソッドfooバーの

実装トリプルスラッシュ・コメントの

空隙

という名前の文字列パラメータ値の入力

これはクラスライブラリプロジェクト内にある場合、私は、XMLコメントを取り除くないだろう - 彼らはインテリセンスに表示されますどのようなものそれらの項目を求めるプロンプトが表示されます。それらを削除すると、他の開発者があなたに非常に怒ってしまう可能性があります。ここのすべてのテキストはあまり良くありませんが、デフォルトのプロンプトはわかりにくく、悪化しています。

+0

私は知っている、私はそれらを手入力した。私はSO上に実際のソースコードを公開するつもりはありません。私は唯一の開発者です。 Intellisenseは、未コメントのメソッドについてメタデータを提供しています。 – MatthewMartin

+0

一般的に同意しますが、この文脈では私はXMLコメントがあまり追加していないと思います。それは本当に何をしているのかについてもっと詳しく述べるべきです。 –

1

私はそれらをより賢明なものに置き換えると、それらを取り除くよりはるかに良いと言いたいと思います。コメントはありません(コメントが間違っている場合を除いて、確かに良いコメントはありません):

私はthis does what you're looking forと言っています。

地域タグの場合、そのアプリを適応させるか、VS正規表現の検索/置換を使用してみてください。

1

私はあなたが入ってきて、それらを見ているように修正すると投票します。私はここで同じことをしなければなりませんでした...毎回、悪いコメントを持つクラスに入る(私の場合は:なし)。私はメソッド/プロパティを私が彼らと一緒にコメントします。 3週間後、コードベースの約1/2についてコメントし、プロジェクト全体をより深く理解しました。

関連する問題