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

命名規則は、変数やメソッドなどのプログラミング構造に割り当てられた名前を管理する一般的な規則を指します。これらの規則により、読みやすさが向上し、異なるモジュール間で命名の一貫性が強化されるため、コードの保守性が向上します。



6
gitリポジトリの命名規則はありますか?
たとえば、Purchase ServiceというRESTfulなサービスがあります。リポジトリに名前を付けますか? purchaserestservice purchase-rest-service purchase_rest_service または、他の何か? 慣習は何ですか?Githubではどうですか?公開リポジトリはいくつかの標準に従うべきですか?

11
Javaでのインターフェースの命名[終了]
現在のところ、この質問はQ&A形式には適していません。私たちは回答が事実、参考文献、または専門知識によってサポートされることを期待しますが、この質問はおそらく議論、議論、投票、または拡張された議論を誘います。この質問を改善でき、再開できると思われる場合は、ヘルプセンターにアクセスしてください。 8年前に閉鎖。 ほとんどのOO言語は、インターフェース名の前に大文字のIを付けています。なぜJavaはこれを行わないのですか?この規則に従わない理由は何でしたか? つまり、ユーザーインターフェイスとユーザー実装が必要な場合は、Javaで2つの選択肢があります。 クラス=ユーザー、インターフェース=ユーザーインターフェース クラス= UserImpl、インターフェース= User ほとんどの言語で: クラス=ユーザー、インターフェース= IUser 今、あなたは常にユーザー実装に最も説明的な名前を選ぶことができ、問題はなくなると主張するかもしれませんが、Javaは物事へのPOJOアプローチを推進しており、ほとんどのIOCコンテナーはDynamicProxiesを広範囲に使用しています。これら2つのことを合わせると、1つのPOJO実装で多くのインターフェースができることになります。 つまり、私の質問は次のように要約されていると思います。「特に、Javaフレームワークが向かっているように見える場所を考慮して、より広いインターフェース命名規則に従う価値はありますか?」

5
MavenアーティファクトとgroupIdの命名
私は現在、AntからMavenにいくつかのプロジェクトを移動している最中です。私はと順応は、私が見つけるための十分に確立規則を使用したいgroupIdとartifactId、私は(そこにいくつかありますが、彼らは私が思ったんだけどポイントをカバーしていない)任意の詳細な規則を見つけることができません。 このプロジェクトを例にとると、まずJavaパッケージ: com.mycompany.teatimer ティータイマーは実際には2語ですが、Javaパッケージの命名規則では、アンダースコアまたはハイフンの挿入が禁止されているため、まとめて記述しています。 私はgroupIdそれが良い考えだと思うので、パッケージIDと同じものを選択しました。それは...ですか? 最後に、私はを選ぶ必要がありますartifactId、私は現在行きましたteatimer。しかし、他のMavenプロジェクトを見るとartifactId、次のようにハイフンを使用して単語をs に分割していますtea-timer。しかし、groupId:に連結すると奇妙に見えますcom.mycompany.teatimer.tea-timer。 どうしますか? もう一つの例: パッケージ名: com.mycompany.awesomeinhouseframework groupId:(com.mycompany.awesomeinhouseframework?) artifactId:(awesome-inhouse-framework?)

5
JavaScriptファイル名の命名規則とは何ですか?[閉まっている]
休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか?この投稿を編集して、事実と引用で回答できるように質問を更新してください。 4年前休業。 この質問を改善する ファイルの名前は、something-with-hyphens.js、camelCased.jsなどの名前にする必要がありますか? この質問に対する答えはここでは見つかりませんでした。

30
他の誰かが、クラスとメソッドの命名をプログラミングで最も難しい部分の1つだと思いますか?[閉まっている]
現在のところ、この質問はQ&A形式には適していません。私たちは回答が事実、参考文献、または専門知識によってサポートされることを期待しますが、この質問はおそらく議論、議論、投票、または拡張された議論を誘います。この質問を改善でき、再開できると思われる場合は、ヘルプセンターにアクセスしてください。 8年前に閉鎖。 だから私はこのクラスに取り組んでいます。このクラスはベンダーにWebサービスを通じてヘルプドキュメントを要求することになっています。私はそれを名前にしようとDocumentRetriever、VendorDocRequester、DocGetter、しかし、彼らはちょうど鳴りません。結局、dictionary.comを30分ブラウジングして、適切な単語を思いついた。 悪い名前を使ってプログラミングを始めるのは、午前中に非常に悪い髪の日をするようなもので、残りの日はそこから下り坂になります。私を感じる?

9
列挙型命名規則-複数
列挙型と一致するプロパティのC#命名規則で似ているが正確ではないにもかかわらず、私はこの質問をしている enumに複数の名前を付け、それらを単数形として「使用」する傾向があることがわかりました。例: public enum EntityTypes { Type1, Type2 } public class SomeClass { /* some codes */ public EntityTypes EntityType {get; set;} } もちろんそれはうまくいき、これは私のスタイルですが、誰かがそのような慣習で潜在的な問題を見つけることができますか?「ステータス」という言葉を使った「醜い」ネーミングがあります。 public enum OrderStatuses { Pending, Fulfilled, Error, Blah, Blah } public class SomeClass { /* some codes */ public OrderStatuses OrderStatus {get; set;} } 追加情報:多分私の質問は十分に明確ではありませんでした。私が定義した列挙型の変数に名前を付けるときは、よく考える必要があります。私はベストプラクティスを知っていますが、これらの変数に名前を付けるという私の仕事を簡単にするのに役立ちません。 すべての列挙型プロパティ(「ステータス」など)を「MyStatus」として公開することはできません。 …

10
_t(下線-t)が後に続くタイプは何を表しますか?
これは簡単な質問のようですが、スタックオーバーフロー検索やGoogleでは見つかりません。タイプの後に_t意味とは何ですか?といった int_t anInt; ハードウェアと密接に対応することを目的としたCコードで多く見られます。それらは関連していると思わずにはいられません。

6
JavaScriptの命名規則[終了]
現在のところ、この質問はQ&A形式には適していません。私たちは回答が事実、参考文献、または専門知識によってサポートされることを期待しますが、この質問はおそらく議論、議論、投票、または拡張された議論を誘います。この質問を改善でき、再開できると思われる場合は、ヘルプセンターにアクセスしてください。 7年前休業。 どの命名規則がJavaScriptに最適かについては、多くの論争(論争ではないかもしれませんが、少なくとも議論)があることを知っています。 変数、関数、オブジェクトなどにどのように名前を付けますか? 私はJSを長い間(数年のみ)行っていないので、私はこれについて自分の考えを残します。そして、作業中のプロジェクトで使用される命名規則を使用してドキュメントを作成するように要求されました。だから私は周りを(google-ing)見ていて、非常に多くの異なる意見があります。 私がJSで読んだ本も、それ自体が異なる命名規則を使用していますが、それらはすべて「1か所であなたに合ったものを見つけて、それに固執する」という点で一致しています。しかし、私はこれまで多くのことを読んだので、他の方法のいくつかが、今までに慣れている方法よりも少し好きであることがわかりました。

8
html / css IDとクラスの標準の命名規則は何ですか?
使用しているプラ​​ットフォームに依存しますか、それともほとんどの開発者が提案/フォローしている共通の規則がありますか? いくつかのオプションがあります: id="someIdentifier"' -JavaScriptコードとかなり一致しているように見えます。 id="some-identifier" -html5のような属性やその他のhtmlに似ています。 id="some_identifier" -ルビコードとかなり一致しているように見え、依然としてJavaScript内で有効な識別子です 上記の#1と#3は、Javascriptとの相性が良いため、最も意味があると考えていました。 これに対する正しい答えはありますか?

11
「静的な最終ロガー」は大文字で宣言する必要がありますか?
Javaでは、静的なfinal変数は定数であり、慣習として、それらは大文字でなければなりません。しかし、ほとんどの人がロガーを小文字で宣言し、それがPMDの違反として現れるのを見てきました。 例えば: private static final Logger logger = Logger.getLogger(MyClass.class); googleまたはSOで「静的な最終ロガー」を検索すると、これが表示されます。 代わりにLOGGERを使用する必要がありますか?

6
JavaScriptのプロパティおよびメソッド名の下線プレフィックス
JavaScriptの下線プレフィックスは、たとえばPythonのプライベートクラスメソッドのように、単なる規則ですか? 2.7 Pythonドキュメントから: オブジェクトの内部以外からアクセスできない「プライベート」インスタンス変数は、Pythonには存在しません。ただし、ほとんどのPythonコードが従う規則があります。アンダースコアで始まる名前(_spamなど)は、APIの非公開部分として処理する必要があります(関数、メソッド、データメンバーのいずれであっても) 。 これはJavaScriptにも適用されますか? たとえば、次のJavaScriptコードを見てください。 function AltTabPopup() { this._init(); } AltTabPopup.prototype = { _init : function() { ... } } また、アンダースコアの接頭辞付き変数が使用されます。 ... this._currentApp = 0; this._currentWindow = -1; this._thumbnailTimeoutId = 0; this._motionTimeoutId = 0; ... 慣習のみ?または、アンダースコアのプレフィックスの後ろにもっとありますか? 私の質問はこの質問と非常に似ていますが、JavaScriptの下線プレフィックスの重要性について賢くすることはできませんでした。

30
不変コレクションの非変更「追加」メソッドに最適な名前は何ですか?
気まずいタイトルで申し訳ありません-簡潔なタイトルを思い付くことができれば、質問する必要はありません。 不変のリストタイプがあるとします。Foo(x)最後に追加の要素として指定された引数を持つ新しい不変のリストを返す操作があります。したがって、値が「Hello」、「immutable」、「world」の文字列のリストを作成するには、次のように記述します。 var empty = new ImmutableList<string>(); var list1 = empty.Foo("Hello"); var list2 = list1.Foo("immutable"); var list3 = list2.Foo("word"); (これはC#コードであり、言語が重要だと思う場合は、C#の提案に最も興味があります。これは基本的に言語の問題ではありませんが、言語のイディオムは重要かもしれません。) 重要なことは、既存のリストはによって変更されないFooため、empty.Count0を返すことです。 最終結果に到達する別の(より慣用的な)方法は次のとおりです。 var list = new ImmutableList<string>().Foo("Hello") .Foo("immutable") .Foo("word"); 私の質問は、Fooの最高の名前は何ですか? 編集3:後で明らかにするように、型の名前は実際にImmutableList<T>はとは限らないため、位置が明確になります。代わりに、それがTestSuite不変であることを想像してください。それが含まれているフレームワーク全体が不変だからです... (編集終了3) これまでに思いついたオプション: Add:.NETで一般的ですが、元のリストの変更を意味します Cons:これは関数型言語では通常の名前だと思いますが、そのような言語の経験がない人には無意味です Plus:これまでのところ私のお気に入り、それは私に突然変異を意味するものではありません。どうやらこれはHaskellでも使用されているようですが、期待が少し異なります(Haskellプログラマーは、単一の値を他のリストに追加するのではなく、2つのリストを一緒に追加することを期待するかもしれません)。 With:他の不変の慣例と一致していますが、IMOとまったく同じ「追加機能」はありません。 And:あまり説明的ではない +の演算子のオーバーロード:本当にこれが好きではありません。一般に、演算子は下位レベルのタイプにのみ適用する必要があると思います。でも、私は説得されても大丈夫です! 私が選択に使用している基準は次のとおりです。 メソッド呼び出しの結果の正しい印象を与える(つまり、追加の要素を含む元のリストである) 既存のリストを変更しないことを可能な限り明確にする 上記の2番目の例のように連結すると妥当な音 はっきりしない場合は、詳細を尋ねてください... EDIT 1:ここに好むのための私の推論ですPlusしAdd。次の2行のコードを検討してください。 list.Add(foo); list.Plus(foo); 私の見解では(これは個人的なことですが)後者は明らかにバグがあります-「x + …

5
Redisのキーの命名規則?
Redisのキーの通常の命名規則は何ですか?値が区切られているのを見たことがあります:が、通常の規則が何であるか、またはその理由はわかりません。 ユーザーのためにあなたは次のようなことをしますか... user:00 ユーザーのIDが 00 すべてのユーザーを返すために、キーの先頭のみを照会できますか? 私は主に、人々のために働く方法と彼らがそれらを選んだ理由を研究することによって、将来の問題を回避したいと思っています。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.