現在、COMオブジェクトのオープンソースラッパーを作成しています。StyleCopをインストールして、コードの一部に対して実行したところ、予想どおり、大量の警告が表示されました(たとえば、すべてのローカルメソッド呼び出しと変数に「this。」を追加するなど、すでに実行しているはずの警告がいくつかあります)。
これらの警告のうち、いくつ試して減らす必要がありますか?オープンソースライブラリを作成するときに最適なものはどれですか?
現在、COMオブジェクトのオープンソースラッパーを作成しています。StyleCopをインストールして、コードの一部に対して実行したところ、予想どおり、大量の警告が表示されました(たとえば、すべてのローカルメソッド呼び出しと変数に「this。」を追加するなど、すでに実行しているはずの警告がいくつかあります)。
これらの警告のうち、いくつ試して減らす必要がありますか?オープンソースライブラリを作成するときに最適なものはどれですか?
StyleCop の一般的な考え方は次のとおりです。
オフにするオプションが多いほど、1 つの真のコード形式を強制する StyleCop の価値は低くなります。そうは言っても、いくつかのオプションが気に入らない場合は、いくつかのオプションを使用するよりも良いオプションを選択し、コードに StyleCop 設定ファイルを含めると、それに取り組んでいる他の人が同じ設定を使用できます。
StyleCop に慣れていない場合、最初は一部の設定が奇妙に思えるかもしれませんが、2 年間使用した今ではすべてのオプションをオンのままにしており、私たちのチームは結果に非常に満足しています.
また、ライブラリまたはフレームワークを提供している場合、FxCopを使用することが StyleCop を使用するよりも重要である可能性があるとも言います。
ほとんどの大規模なオープン ソース プロジェクトには、独自のスタイル ガイドラインがあります。たとえば、Apache C 言語スタイル ガイドは次のとおりです。
手始めに、興味のある OS プロジェクトの FAQ を調べて、そこから取得することをお勧めします。
とにかく、既存のスタイル ルールを大幅に破っている場合は、すぐに知らせてくれる人がたくさんいると思います。;-)
すべての警告に注意してください。通常、それらは何か役に立つことを伝えようとしています。実用的なプログラマーが言うように、「偶然によるプログラミング」(本の抜粋) を終わらせないでください。
編集:これがあなた自身の新しいOSプロジェクトであることに気づきませんでした。私の悪い。とにかく、いくつかの類似した既存の OS プロジェクトを調べて、スタイル ガイドがあるかどうかを確認します。間違いなく、Steve McConnell の本 Code Complete をチェックしてください ( Amazon リンク- これらのホールを歩き回るスクリプト キディ リンク ナチスのためにサニタイズされています)。
警告と「偶然のプログラミング」について述べたことは、今でも当てはまります。(-:
HTH。
乾杯、
ロブ