2009-05-08 14 views
2

私はコーディング標準のドキュメントを更新しようとしていますが、私はおそらく一般的に行われているより幾分高いレベルでそれらを書くことを考えています。私たちにはかなりの量の開発者が出入りしており、一般的には中間のスキルレベルです。私は低品質の "毛羽"セクションを排除したいと思います...例えば、 "変数命名規則"など...本当に疑わしい値で、文書の真価の部分から気をそらすもの過度の価値の低いコンテンツのためにスキミングされたりスキップされる可能性があります。"Common Sense"または実用的な.NETコーディング標準

私は、人々が特定のやり方で行動するのではなく、愚かなことをしないようにすることにもっと興味があります。

私たちはOracle/Oracleのショップであることがありますが、私が探している資料のタイプについては、特に言語は重要ではないと思います。

これまで誰もこれをやっていて、共有してもらえないか、それとも似たような性質を持つ良いオンライン素材を見つけたのかな?

答えて

4

私は間違いなく標準的な文書よりもツールオプションReSharperを好んでいます。私が専門的に開発するほど、標準文書をコーディングすることは時間の無駄であり、生産性の低下につながることに気付きます。

コードは読みやすく理解できるものでなければなりません。残念ながら、コーディング標準ではどちらも強制できません。しかし、ツールは少なくとも命名規則を強制し、ヌルをチェックできなかったり、「変更されたクロージャへのアクセス」などの問題を見つけるのに役立ちます。

どのような場合でも、コーディング規格は、開発者に良いコードを書くことを決して許してはいけません。私は、三項演算子または演算子オーバーロードの使用を禁止する文書を見てきました。また、コードにコメントを付けることが必要な文書も見てきました(私は、すべてのコストをかけてコメントを避けようとしています)。私の意見では、これらの事柄のどれもコーディング標準にすべきではありません。

+0

私は、特定の回答に対して複数回投票できる必要があると感じたのは初めてです。注 - これまで私はコードガイドライン/標準について非常に苦労していました。私は今ブライアンのキャンプに正面から落ちる。 – Tim

+0

ピアレビューのいくつかの使用は、コーディング標準よりも進んでいます。あなたは実際にはより良い作業成果物を得ますが、文書では何も得られません。 – Tim

+0

私はコーディング標準が何であるか気にしません。私はそれについて考えさせないでください。この理由から、私は最も賢明な標準はR#のデフォルトを使うことだと思う。それはまともな基準であり、侵害されたときに明白にするためにあなたが必要とするものは何もありません(あなたの同僚にR#を使用するように説得することを除いて)。 –

1

MSDNのguidelines for class developersには多くの優れた素材があります。あなたのような低レベルのものはたくさんありますが、それは実際にはより多くの価値がありますが、一見価値があります。

0

JPが投稿したガイドラインに従っているセクションや、そのコードが最低スコアでFxCopに合格する必要があります。これにより、ドメイン固有のガイドのために標準のスペースが広がります。

4

私の経験では、コーディング標準の実用的価値は、自動的に測定する能力に比例します。私たちのショップのC#コーディング標準(1ページに収まる)の一部は、コードがFxCopとStyleCopの両方のデフォルトルールに従ってきれいでなければならないと言います。両方のツールは、開発者だけでなくビルドプロセスによっても実行できます。

+2

StyleCopはコーディングスタイルの基準を定義します。それは非常に柔軟性がなく、それは良いことです - それはあなたに何を伝えるのですか、中括弧を置く場所について議論を止めます(ジョエルの「ベストソフトウェアライティング」を読むべきだと論じ続けています)。 FxCopは、APIを定義するときにあなたを適切な軌道に維持します。ここでは、特定の問題を無視するように指示することができますが、少なくともベストプラクティスがあると言われます。 –

+0

「自動的に測定する能力」について私は同意しますが、FxCopとStyleCopの両方にデフォルトルールを使用することについては同意しません。例えばCA1805 - DoNotInitialize、CA1016 - MarkAssembliesWithAssemblyVersion、CA1044 - PropertiesShouldNotBeWriteOnly c.f. http://www.paraesthesia.com/archive/2008/10/30/fxcop-rule-recommendations.aspx –

関連する問題