タグ付けされた質問 「coding-standards」

コーディング標準またはコーディング規約は、ソフトウェアプロジェクトでのコード生成のプロセスを管理するために設計された一連のルールまたはガイドラインです。それらは通常、業界のベストプラクティスまたは一般に受け入れられている規則に基づいています。これには、命名規則、スタイル、禁止されている機能などが含まれます。

9
「ワンリターンのみ」という概念はどこから来たのですか？
「同じメソッドに複数のreturnステートメントを入れないでください」と言うプログラマーとよく話します。理由を教えてもらうと、「コーディング標準がそう言っている」または「わかりにくい」だけです。単一のreturnステートメントでソリューションを表示すると、コードが見苦しくなります。例えば： if (condition) return 42; else return 97; 「これは見苦しいです。ローカル変数を使用する必要があります！」 int result; if (condition) result = 42; else result = 97; return result; この50％のコードの肥大化により、プログラムが理解しやすくなりますか？個人的には、簡単に防ぐことができた別の変数によって状態空間が増加したため、私はそれが難しいと感じています。 もちろん、通常は次のように書きます。 return (condition) ? 42 : 97; しかし、多くのプログラマーは条件演算子を避け、長い形式を好みます。 この「一回限りの帰り」という概念はどこから来たのでしょうか？このコンベンションが生まれた歴史的な理由はありますか？
15
ブールパラメータを使用して動作を決定するのは間違っていますか？
私は時々「違和感を感じる」練習を見てきましたが、それについて何が悪いのかを明確に説明することはできません。または多分それはちょうど私の偏見です。ここに行く： 開発者は、パラメータの1つとしてブール値を使用してメソッドを定義し、そのメソッドは別のメソッドを呼び出すなど、最終的にそのブール値は、特定のアクションを実行するかどうかを決定するためだけに使用されます。これは、たとえば、ユーザーが特定の権限を持っている場合、またはテストモード、バッチモード、またはライブモードの場合（またはそうでない場合）にのみアクションを許可するために、またはシステムが特定の状態。 さて、それを行う別の方法が常にあります。（パラメータを渡すのではなく）アクションを実行するときを照会するか、メソッドの複数のバージョン、またはクラスの複数の実装などを使用します。私の質問はこれをどのように改善するかではなく、むしろそれが本当に間違っているかどうか（私が疑うように）、もしそうなら、何が悪いのか。
14
ボブおじさんが、コーディング標準を避けることができれば書き留めてはならないと提案するのはなぜですか？
私がこの質問を読んでいる間、トップ投票の回答はコーディング基準についてボブおじさんを引用しましたが、私はこのヒントに混乱しました： 回避できる場合は書き留めないでください。むしろ、コードを標準の取得方法にしてください。 これは私の脳内で跳ね返りましたが、固執する場所を見つけることができませんでした。新しい人がチームに参加した場合、またはコーディング標準が変更された場合、情報の混乱はありませんか？ コーディング標準を書き留めてはいけないのはなぜですか？
17
明確にするためのコーディング標準：コードのすべての行をコメントしますか？
私は、命に関わるソフトウェアを製造する店で働いており、コードを読みやすくして潜在的に命を救うことを意図したコメントルールに対処しました。私の経験では、この要件はチェックリストにチェックを入れるのは頭の痛い雑用になり、理解可能なコードを書くことに集中し続けるのに役立ちません。また、ピアレビューアが、コードを理解しやすくする方法について、より有意義な会話をすることを妨げます。 また、コメントのない学生コードを評価し、それらを無視するためにマークダウンする必要がある理由を確認しました。 適切な名前を使用し、構造をシンプルにし、機能を短くし、モジュールに焦点を当てると、コメントを最小限に抑えることができるほど十分にコードを理解しやすくなります。 また、コメントは、コードが方法ではなく、コードが実行する理由を説明する必要があることも理解しています。 このすべてを考えると、このアイデアをキャプチャする良いコーディング標準を書くことさえ可能ですか？ピアレビューに関連するものの、「42行目にコメントするのを忘れた」以上の有用なメモを生成する、気まぐれなチェックリストアクティビティにならないもの。 このルールがチェックリストの行として扱われる場合に必要となる種類のコードの例： /* Display an error message */ function display_error_message( $error_message ) { /* Display the error message */ echo $error_message; /* Exit the application */ exit(); } /* -------------------------------------------------------------------- */ /* Check if the configuration file does not exist, then display an error */ /* …
10
なぜ私たちのほとんどが「i」をループカウンター変数として使用するのですか？
なぜ私たちの多くが同じ変数名を使用してこの同じパターンを繰り返すのかを考えたことはありますか？ for (int i = 0; i < foo; i++) { // ... } 私が今まで見てきたほとんどのコードはi、繰り返し変数としてj、kなどを使用しているようです。 私はどこかからそれを拾ったと思うが、なぜこれがソフトウェア開発でそれほど普及しているのだろうかと思う。それは私たち全員がCから拾ったものなのでしょうか、それともそのようなものですか？ 頭の後ろでしばらくかゆみがありました。
19
機能が短すぎますか？
同じロジックを複数回記述していることに気付くたびに、通常、それを関数に固定するため、アプリケーション内でそのロジックを維持する必要がある場所は1つだけです。副作用は、次のような1行または2行の関数になることです。 function conditionMet(){ return x == condition; } または function runCallback(callback){ if($.isFunction(callback)) callback(); } これは怠け者ですか、それとも悪い習慣ですか？これは、非常に小さなロジックの関数呼び出しの数が多くなるためです。
4
「長い」禁止は理にかなっていますか？
今日のクロスプラットフォームC ++（またはC）の世界では、次のことができます。 Data model | short | int | long | long long | pointers/size_t | Sample operating systems ... LLP64/IL32P64 16 32 32 64 64 Microsoft Windows (x86-64 and IA-64) LP64/I32LP64 16 32 64 64 64 Most Unix and Unix-like systems, e.g. Solaris, Linux, BSD, and OS X; z/OS …
6
メソッドvs機能vs手順
簡単な質問ですが、このような猛烈さで定義されたこれらの3つの用語をよく耳にしますが、これは長年にわたって異なることを意味することが知られています。 「手順」、「方法」、「関数」、「サブルーチン」などの「正しい」定義とは何ですか？
16
ハンガリー記法を使用しないことの利点は何ですか？
私が苦労していることの1つは、ハンガリー記法を使用していないことです。私はしていないだけで、それが何であるかのタイプを参照する変数の定義に行かなければならたいです。プロジェクトが大規模になると、「bool」という接頭辞が付いた変数を見て、0/1値ではなくtrue / falseを探していることを知ることができてうれしいです。 SQL Serverでも多くの仕事をしています。データベース内のすべての変数は言うまでもなく、ストアドプロシージャの先頭に「sp」、テーブルに「tbl」を付けます。 ハンガリーの表記法を実際に使用したくない人は誰もいないと思うので、それを避けます。私の質問は、ハンガリーの表記法を使用しないことの利点は何ですか？また、大多数の開発者がペストのようにそれを避けるのはなぜですか？
14
プログラムをゼロから完全に再構築した場合、ずっと改善したいという気持ちを常に避けることができますか？[閉まっている]
私はかなりの量のコーディングを学びましたが、それは常に科学環境（コンピューターサイエンスではない）で行われ、誰も私を正しい方向に導くことなく完全に独学で学びました。したがって、私のコーディングの旅は...面倒でした。ある種のプログラムを構築するたびに、最終的には、はるかにエレガントに、はるかに効率的に、そしてはるかに柔軟性があり、今後の管理が容易な方法でそれを実現できたことに気付きました。状況によっては、実際に戻って一から物を作り直したことがありますが、通常これは実際には実行できません。これまでの私のプログラムのほとんどは比較的小さいものでしたが、何かを作成するたびに大きなプログラムを完全に書き換えることは非常に面倒です。 私はただこれが普通の経験なのだろうか？そうでない場合、これをどのように防止しますか？事前に計画を立ててみましたが、コードを打ち出すまですべてを実際に予測することはできません。
20
コードの行数を減らすことはどれほど重要ですか？
私はJ2SE（コアjava）で作業するソフトウェア開発者です。 多くの場合、コードレビュー中に、コードの行数を減らすように求められます。 冗長なコードを削除することではなく、コード内の少ない行で同じことを行うことに焦点を当てたスタイルに従うことです。行の数を増やすことを意味する場合でも、コードを明確にすることを信じています。 物事を行う正しい方法は何だと思いますか？ LOC（コード行）が小さい場合、コードにどのような影響がありますか？LOCの数値が大きい場合、コードにどのような影響がありますか？ ウェブサイトからの例： "javaranch"- public static void happyBirthday(int age) { if ((age == 16) || (age == 21) || ((age > 21) && (((age % 10) == 0) || ((age % 25) == 0)))) { System.out.println("Super special party, this year!"); } else { System.out.println("One year older. Again."); …
6
単一引用符と二重引用符[閉じた]
Javaのバックグラウンドから来てPythonを書く仕事を始めたばかりで、他の開発者''は二重引用符（）ではなく一重引用符（""）を使用して文字列を引用する傾向があることに気付きました。例えば： line1 = 'This is how strings typically look.' line2 = "Not like this." これには、個人的な好み以外に特別な理由がありますか？これは文字列を引用する適切な方法ですか？特に、私が知りたいのは、このスタイルのコーディングを推進する何らかの標準または受け入れられたベストプラクティスがあるかどうかです。
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.