タグ付けされた質問 「naming」

私が木を持っていた場合、直感的に「平らにする」ことを意味します ツリー内のすべてのアイテムのリストを取得し、左から右に移動しますか？ リンクされたリストがある場合、直感的に「フラット化」されます これから始まるすべてのアイテムのリストを取得する たとえば、リンクリストは、その内部例外を集約する例外で構成されます。例外のシーケンスを返すことを期待して、例外「flattenInnerExceptions」のメソッドに名前を付けるのは公平でしょうか？最初に最も外側の例外、最も内側の例外-最後に？

13 naming 

Javaでは、慣例により、ブールフィールドのゲッターおよびセッターはisField()およびになりsetField()ます。これは、のような形容詞ですフィールド名と完全に正常に動作しactive、visible、closed、など しかし、次のような動詞の意味を持つフィールドに名前を付けるにはどうすればよいhaveChildrenですか？「_ing」を動詞（）に追加しますか？havingChildren 明確にするために、メソッド名（getterおよびsetter）はIDEによって自動生成されるため、制御できません。したがって、必要なのは適切なフィールド名であり、IDEがそのゲッターを生成するときに意味があります。たとえば、hasChildrenは完全なフィールド名ですが、IDEがフィールドのゲッターを生成すると、になりますisHasChildren。これをどうやって解決しますか？

13 java  naming 

中規模のCライブラリプロジェクトの関数命名規則に関する実用的なアドバイスを見つけるのに苦労しています。私のライブラリプロジェクトは、独自のヘッダーを持ついくつかのモジュールとサブモジュールに分割され、大まかにOOスタイルに従います（すべての関数は、グローバルなどではなく、最初の引数として特定の構造体を取ります）。次のように配置します。 MyLib - Foo - foo.h - foo_internal.h - some_foo_action.c - another_foo_action.c - Baz - baz.h - some_baz_action.c - Bar - bar.h - bar_internal.h - some_bar_action.c 一般的に、関数は大きすぎて（たとえば）固執some_foo_actionしanother_foo_action、1つのfoo.c実装ファイルに入れて、ほとんどの関数を静的にして、1日で呼び出します。 ユーザーのクライアントプログラムとの競合を避けるために、ライブラリを構築するときに内部（「モジュールプライベート」）シンボルを削除することもできますが、問題はライブラリ内のシンボルの名前の付け方ですか？これまで私はやってきた： struct MyLibFoo; void MyLibFooSomeAction(MyLibFoo *foo, ...); struct MyLibBar; void MyLibBarAnAction(MyLibBar *bar, ...); // Submodule struct MyLibFooBaz; void MyLibFooBazAnotherAction(MyLibFooBaz *baz, ...); しかし、私は（例よりはるかに長い）クレイジーな長いシンボル名になってしまいました。名前の前に「偽の名前空間」を付けない場合、モジュールの内部シンボル名はすべて衝突します。 注：キャメルケース/パスカルのケースなどは気にせず、名前だけを気にします。

13 c  naming  project-structure 

Pythonで関数の名前を選択することについて混乱しています。時々 、Pythonは組み込み関数ですが不可欠のような：print機能と文字列の方法find。時々、それらは次のようなものではありません：lenその名前はcalculate_len、たとえばなどの命令型でtypeはなく、find_typeです。 これprintは、使用しない値（つまりNone）を返し、何かをする（つまり、画面に文字列を表示する）ため、その名前は必須です。 ただしlen、使用する値を返し、何かを実行します（つまり、シーケンスまたはマッピングに存在するアイテムの数を計算します）。その名前は必須ではありません。一方、find文字列メソッド（as len）は、使用する値を返し、何かを実行します。その名前は必須です。 この質問をしたのは、Caesar暗号を使用して文字列を暗号化および復号化するスクリプトをレビューに追加したことです。レビューアは次のように言った： ただの直感：関数は何かをします。したがって、関数の適切な名前は必須rotate_letterですrotated_letter。代わりにを使用します。 rotated_letter数字で回転した文字を表す1文字の文字列を返します。私はrotated_letterそれが値を返すのでrandint、ランダムモジュールの関数のように使用しましたが、そうではありませんgenerate_randint。 したがって、この場合、使用する値を返す関数にどのように名前を付ける必要がありますか？名前を必須にするべきか、それとも名詞にするべきか。他の場合では、次のような、それを行う方法は明らかですブール関数のような、is_evenそしてis_palindrome我々は同じようにそれを作るはい/いいえ質問し、また機能だけで行うと戻り未使用の値（つまり、Noneなど）、printおよびlistメソッドsort。

13 python  naming  functions  naming-standards  python-3.x 

閉じた。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善したいですか？この投稿を編集して事実と引用で答えられるように質問を更新してください。 4年前に閉鎖されました。 関数/変数/などを定義していて、それを何と命名するかわからない場合、何と命名しますか？どうやって名前を思いつきますか？ 仮の名前を実際の名前になるまでプレースカードとして使用する場合、どの一時的な名前を使用しますか？ 更新 私は次のようなものを使用しているWILL_NAME_LATER、NEEDS_NAMEまたはTO_BE_NAMED。私は、採択された規約があることを望んでいました。この採択された規約を使用した場合、変更するまでIDEが名前を強調表示することを望んでいました。

13 naming  variables  functions 

単体テストを使用すると、ドメインが非常に小さくなるため、簡単です。私はオセロベのmethodName_conditions_result()スキームを使用しましたが、それは非常に明確でした。 しかし、統合テストでは、非常に長い名前になると思いmethodNameます。代わりに何を入れますか？統合テストクラスに名前を付けるにはどうすればよいですか？ 統合テスト名の実際の例は大歓迎です。答えがこれらのテストをよりよく理解するのにも役立つことを願っています。

13 testing  naming  integration-tests 

では私のこの答え、私が使用し_t最高の状態で、物議を終了タイプ、の終わりに。これが現在のプロジェクトで使用しているプラ​​クティスです。 typedef struct { int x; int y; } point_t; これはstddef.h、size_tまたはのようなCタイプと一致するように意図されていましたptrdiff_t。しかし、私の質問の特定のコメントによると、_tpostfixはPOSIXのために予約されているようです。代わりに何を使うべき_tですか？または、_tとにかく使用し続ける必要がありますか？ この質問は、CとC ++の両方を対象としています。これらの言語の表記規則が異なる場合は、お気軽にお答えください。

12 c++  c  naming 

閉まっている。この質問はトピック外です。現在、回答を受け付けていません。 この質問を改善したいですか？ 質問を更新して、 Software Engineering Stack Exchangeのトピックになるようにします。 4年前に閉鎖されました。 CIで大規模プロジェクトをコーディングする際に問題が発生しました。さらにコードを書き続けると、コードを整理するのが難しくなることがあります。プログラムのさまざまな部分の関数と変数の命名が混同されているように見えるかもしれません。 それで、Cの変数と関数に使用できる便利な命名規則があるかどうかを考えていましたか？ ほとんどの言語は命名規則を提案しています。しかし、Cについては、これまで読んだ唯一のことは、コードの読みやすさを説明する名前でなければならないということです。 編集： 推奨される命名規則のいくつかの例の例： PythonのPEP 8 Javaチュートリアル Javaの命名規則をどこかで読みましたが、どこにあるのか覚えていません。

12 c  naming 

私は化学システムをモデリングしていますが、列挙内の要素/アイテムの命名に問題があります。 私が使用すべきかどうかはわかりません： 原子式 化学名 省略された化学名。 たとえば、硫酸はH2SO4で、塩酸はHClです。 それら2つでは、合理的に一般的であるため、おそらくアトミック式を使用します。 しかし、Na2SiF6であるヘキサフルオロケイ酸ナトリウムのような他のものがあります。 その例では、原子式は（私には）それほど明白ではありませんが、化学名は恐ろしく長いです： myEnum.SodiumHexaFluoroSilicate。一貫した命名パターンを持つ短縮された化学名を安全に思い付くことができるかどうかはわかりません。 enum要素に名前を付けることで対処しようとしている問題がいくつかあります。 1つ目は読みやすさで、長い名前では問題が発生します。 2つ目は、新しいメンテナー向けのコードを簡単に選択できることです。ここでは、短い名前が問題を示しています。 次の問題は、事業主が通常完全な化学名を参照することですが、常にではありません。「一口」の化学物質は、その式で呼ばれます。 最後の懸念は、それが一貫していることを確認することです。どちらを使用するか覚えておくことができないので、私は混合命名規則を望んでいません。 メンテナンスの観点から、上記の命名オプションのどれをご覧になりますか？その理由は何ですか？ 注：線の下にあるものはすべて補足です。明確化資料。動揺しないでください。主な質問は、厄介なオブジェクトの命名に関するものです。 アトミックオプション public myEnum.ChemTypes { H2SO4、 HCl、 Na2SiF6 } 化学名オプション public myEnum.ChemTypes { 硫酸、 塩酸、 ヘキサフルオロケイ酸ナトリウム } この質問に関するコメントからの追加の詳細を次に示します。 コードの対象者は、化学者ではなくプログラマーだけです。 私はC＃を使用していますが、実装言語を無視する場合、この質問はより興味深いと思います。 私は10-20の化合物から始めており、最大で100の化合物を持っているので、可能なすべての化合物について心配する必要はありません。幸いなことに、これは固定ドメインです。 列挙型は、一般的/一般的な化学計算を容易にするためのルックアップのキーとして使用されます。つまり、式はすべての化合物で同じですが、化合物のプロパティを挿入して式を完成させます。 たとえば、化合物の質量（グラム）からモル数を計算する場合、モル質量（g / mol）が使用されます。FWIW、モル質量==モル重量。 一般的な計算の別の例は、理想気体の法則と特定気体定数の使用です。 サンプル関数は次のようになります。 public double GetMolesFromMass（double mass_grams、myEnum.ChemTypes chem） { double …

12 naming  complexity 

私はJavaのバックグラウンドで、JavaScriptを初めて使用しています。次の例のように、単一文字のパラメーター名を使用する多くのJavaScriptメソッドに気付きました。 doSomething(a,b,c) 好きではありませんが、仲間のJavaScript開発者が、これはファイルサイズを小さくするために行われ、JavaScriptファイルをブラウザーに転送する必要があることに気付きました。 それから私は別の開発者と話をしていることに気づきました。Firefoxがページをより速くロードするために変数名を切り捨てる方法を教えてくれました。これはWebブラウザーの標準的なプラクティスですか？ JavaScriptでプログラミングする際に従うべきベストプラクティスの命名変換は何ですか？識別子の長さは重要ですか？その場合、どの程度ですか？

12 javascript  naming  coding-standards  conventions 

閉じた。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善したいですか？この投稿を編集して事実と引用で答えられるように質問を更新してください。 4年前に閉鎖されました。 Resolve依存関係の挿入（インターフェイスへの実装の解決）、パッケージマネージャー（例：パッケージの依存関係の解決）、Web（例：ホスト名の解決）で、単語が使用される多くの場所で見ます。 では、コードのロジックを特別なものにして、誰かResolveが単純なConvert、Transformまたはさらには単語を選択するようにするのはGetなぜですか？

12 programming-practices  naming  dependency-injection  packages 

Golangがここにあるスタイルガイドに最も近いのは、Receiver Namesの下です。 メソッドのレシーバーの名前は、そのアイデンティティを反映したものでなければなりません。多くの場合、そのタイプの1文字または2文字の略語で十分です（「クライアント」の「c」または「cl」など）。「me」、「this」、「self」などの汎用名は使用しないでください。これらは、関数ではなくメソッドに重点を置くオブジェクト指向言語の典型的な識別子です。名前はメソッドの引数のように説明的なものである必要はありません。その役割は明白であり、文書の目的には役立たないからです。 個人的には、「this」が関数の記述および編集時に取り組んでいるものの焦点であるため、常に「this」を識別子として使用しています。それは正しいように聞こえ、（少なくとも私には）理にかなっています。 名前が記述的である必要がない場合、その役割は明白であり、ドキュメンタリーの目的を果たしません。なぜ「これ」の使用が眉をひそめるのでしょうか？

12 coding-style  naming  golang 

たとえば、次の関数は、入力フィールドの名前とエラーを含む配列をループします。これは、検証フィールドの名前を確認し、エラー情報を無効なフィールド配列にプッシュすることにより行います。 簡潔にこれを書く方が良いですか？ addInvalidField (field, message) { const foundField = this.invalidFields.find(value => { return value.name === field.name }) const errors = foundField.errors if (!errors.some(error => error.name === message)) { errors.push({ name: message, message }) } }, または、このように具体的にしますか？ addInvalidField (validatingField, message) { const foundField = this.invalidFields.find(invalidField => { return validatingField.name === invalidField.name …

11 coding-style  naming 

たとえば、関数型言語では、変数は単一の割り当てであり、値は割り当てられると不変です。そのため、バインドされていない状態とバインドされた状態の2つがあり、一度バインドされると変更できません。 そのようなものに最も適した数学用語や他のコンピューター科学用語はありますか？意味的に分散や可変性を意味しないもの。 termなど存在しない場合、およびそのような構造を持つ言語を設計している場合、これらに使用するのは単語変数以外です。 私はアイデアを投票するつもりはありません。そのようなことに対して受け入れられている業界（業界）の用語があるかどうかを把握しようとしています。

11 language-agnostic  naming  language-design  language-features 

閉まっている。この質問はトピック外です。現在、回答を受け付けていません。 この質問を改善したいですか？ 質問を更新して、 Software Engineering Stack Exchangeのトピックになるようにします。 8年前に閉鎖されました。 Velocity Template Languageのsetディレクティブには、左側に変数が必要です。これは機能しません。 #set ( $entries.add("d") ) の戻り値は使用できませんadd("d")が、変数に割り当てる必要があります。 #set ( $x = $entries.add("d") ) 変数が必要であることを伝えたいのですが、後で使用するつもりはありません。コンパイラーをなだめるためにのみ存在する変数の命名規則はありますか？

11 naming  syntax