2013-08-06 2 views
9

ReSharperで最近プレイしたことがあり、C#クラスやC#ファイルにset code commenting standardがないと私のチームのために設定したいと思うことが1つあります。残念ながら私はまだその話題を多く見つけることができませんでした。例えばReSharperを使用してコメント標準を適用できますか?

、私はすべてのメソッドや関数は、それらの上のコメントの記述があることを確認したいと思います:

/// <summary> 
/// Description of MyMethod here. 
/// </summary> 
public void MyMethod(); 

私もどうか(コードの行数)のためにその基本的なチェックを見たいのですが/(コメントの行数)は、魔法の幸福媒体のまわりであり、そうでなければ通知または警告を作成します。

答えて

16

XML文書ファイルの生成をオンにしてから、警告をエラーとして処理するという簡単なオプション(R#は必要ない)もあります。それはすべてののパブリックメンバーがドキュメントを持っていることを保証します。

コメントが確実にであることを保証するものではありませんが、それらが存在することが保証されます。

EDIT: - コード検査の下、検査重大度、C#の、コンパイラ警告、(それに近く、関連の警告)CS1591: Missing XML comment for publicly visible type or member探しのR#は、このための設定を持っています。そのエラーの重大度を「エラー」に変更してください。が役に立ったかもしれませんが、珍しい環境では言うことは難しいです。

+0

通常の状況下での質問の最初の部分に非常にきちんとした解決策 - 私たちはプロジェクトのビルドを実行するためのVisual Studioを使用していないUnity3Dエンジンを使用しているように私は、特にR#ソリューションを必要とするが、私は上記のことをうまく利用することができません。 –

+2

@ S.Richmond:私は混乱しています - R#はVisual Studioプラグインです。あなたがVSを使っていないなら、R#をどうやって使うのですか?また、私が今までに見たことのあるすべてのC#コンパイラは、XMLドキュメント出力を生成することができます。そのオプションを探しましたか?これはVisual Studioに固有のものではありません。たとえば、mcs(Mono C#コンパイラ)を使用する場合は、 '-doc'引数を使用します。最後に、あなたが奇妙な要件を持っているなら、まずは質問にそれらを含めるべきです。 –

+0

私たちはVS2012を使用していませんが、Unity3DはIDEとしてのみ使用します。 Unity3Dはビルド自体を実行します。私の質問は、その理由のためにR#の解決策を求めました。 –

2

Jonとは競合しませんが、GhostDocはあなたの説明をします。また

enter image description here

+0

+1良い "ベストエフォート"のソリューションではあるが、自動文書化の良い試みを提供することができますが、開発者の変更が_good_変更であることを保証するものではありません... – Basic

+0

@Basic Thanks、ポリシーでは、バージョン管理上の高品質なゲート、コードをチェックインしてビルドする前に完了しなければならないタスクがあります。例としては、コード変更によって回帰バグが導入されないようにするテストポリシー、チェックインされたコードが確実に合意された基準を満たすコード分析ポリシー、およびワークアイテムポリシーを使用してスコープクリープを減らし、テスターが与えられたアプリケーションのビルド。 –

+0

@JeremyThompson GhostDocはVS2012以上ではもはや多く使用されていますか?どのメソッドの上にでも '///'を入力すれば、記入のためのコメント標準が自動的に生成されます。 –

2

、(ETCメソッド、プロパティ、のために)欠けているコメントを意味するReSharperのプラグインを有するStyleCopをチェックアウトは、ReSharperの警告/エラーとして表示されます。あなたにとって興味があるかもしれませんが、少なくともそれはオプションです。

0

Stylecopには多くのコメントルールがあります。Stylecop+には、メソッド/プロパティの長さに関するいくつかの特別なルールがあります。

2

2つのオプションがあります。どちらも - ReSharper用の拡張機能を使用する - Visual Studio用ではありません(わからない場合は、ReSharperに独自の拡張マネージャがあります)。これらの拡張機能は、(!が第二いずれかを使用)は次のとおりです。(R#9用)

  1. AgentSmith。今、私のReSharperのExtension Managerは、この拡張機能はバージョン9.0のReSharper(私がインストールしたもの)用ですが、実際にはこの拡張機能はエラーで機能します(ハイライトの無効化は正しく機能しません)。

  2. ReSharper 9のXML Doc Inspections。 (私はちょうどインストールされている)問題なく動作しているようだ。 これは、XMLコメントを持たないクラス、メソッド、プロパティなど(プライベートフィールドでさえも)を強調するために本当に必要なものです!

関連する問題