一般的に受け入れられているコード形式のガイドラインは何ですか?

Question

によると マッコールの品質モデル, 製品の改訂 ソフトウェア製品の品質特性を説明するための 3 つの主要な視点の 1 つです。製品リビジョンの観点では、 保守性, 欠陥を見つけて修正する能力, 、ソフトウェアを改訂する能力に影響を与える重要な品質要素として特定されています。

改訂プロセスのある時点で、人間の関与、特にプログラマーの関与が必要になることは明らかです。コードのフォーマットは、プログラマーがソフトウェアを効果的かつ効率的に修正できるかどうかに影響します。

コード改訂プロセスにおいてプログラマーの効率と有効性を最大化する、一般に受け入れられている、言語に依存しないコードフォーマットのガイドラインに取り組んできましたか?

Answer 1

私がこれまで取り組んできた最良のガイドラインは一貫性です。何年にもわたって、私はさまざまなチームでさまざまなスタイルを使用してきました...私が見た中で最高の結果は、スタイルに関係なく、チーム全体が同じスタイルを使用することを強制されたときです :-)

Answer 2

いくつかの言語に依存しない概念について、いくつか考えがあります。

1.) デッドコードを削除します。何かが絶対に重要でない限り、コメントアウトされたデッドコードは削除する必要があります。ルーチンが乱雑になり、文字列を検索すると誤検知が頻繁に発生し、プロの開発者にとって好ましくない全体的なずさんさを示します。

2.) メンテナンス修正については、コメント内の欠陥追跡番号を参照してください (何らかの欠陥追跡システムがある場合)。これにより、あなたの作業を管理している人は、あるリビジョンと別のリビジョンの間でコードが変更された理由を簡単に理解できるようになります。

3.) サポートする言語の場合は、変数を最初の使用にできるだけ近い状態で宣言します。

他にも言語に依存しない概念がいくつかあると思いますが、最初に思い浮かぶのはこれらのいくつかです。私の知る限り、特定の言語が存在しない場合、コーディング標準について議論することは比較的困難です。私も上記の他の回答に同意します。最良のスタイルとは、通常、既存のスタイルと最もシームレスに融合するものです。

Steve McConnell の記事を見てみるのもいいでしょう。 コードの完成. 。プログラミング言語に関係なく、ほぼすべての開発状況に適用できる優れたアイデアが満載です。

Answer 3

一貫性が鍵です。ガイドラインをどこかに書き留めて、準拠することを要求します。

コードのフォーマットについては、心配したり議論したりする必要はありません。いくつかのルールを作り、それを守りましょう。

Answer 4

私もジョエルさんの意見に同意します。世の中にはスタイルの例がたくさんあります。ほとんどは良いです。一部のものは他のもの (ハンガリー語表記?) ほど役に立たなくなりました。ただし、重要なのは一貫性です。新しい開発者が各開発者の個人的なスタイルに慣れる必要がなく、すぐにコードを理解できる限り、機能します。

およそ 1 年ごとに規格を切り替えるのはおそらく悪い考えです。

Answer 5

私も Joel の意見に同意します。組織内で一貫性があれば、保守性は大幅に向上します。別のチームに参加する場合、すべてが現在のチームと同様の外観と操作性を備えていれば、立ち上げ時間ははるかに短くなります。頭を動かすための「内部コンテキストの切り替え」を行わなくても、はるかに速くコードを読むことができるためです。 _var の代わりに mVar" / など

Answer 6

私たちの優れた標準の 1 つは、可変の「接頭辞」です。ここに来るまではソロで書くことが多かったので、あまり心配していませんでした。

変数には、それが何であるかを示す接頭辞を付けて名前を付けることが「必須」です。そのため、dpVarName を見ると、それが double へのポインターであり、lVarName が long int であることがすぐにわかります。

最初は、ブロックを括弧で囲むための 2 つの選択肢が与えられたことをうれしく思いましたが、今では、全員がどちらかの方法で強制的に実行することを強制されればよかったと思っています。