タグ

namingに関するxai1981のブックマーク (101)

  • メソッド名、迷った時に参考にできる単語一覧

    プログラムコーディング時に変数名、プロパティ名で悩むことは多々あります。 指針、決めを、ルールを知れば迷いが減ります。 ここでは、なぜそのルールで命名するのか?と、 プログラム業界にて一般的に使われている単語を紹介します。 悩んだ時は参考にして命名すると悩みを減らすことができます。 基的なルール変数名、メソッド名を命名する時に気をつける基を上げます。 名前は開発環境が補完するので解りやすければ長くても良い。Typo しないよう辞書で確認する。日語は同じだが英語で複数の単語がある場合は違う単語と間違えないよう辞書で確認する。名詞、動詞、過去形、複数形に注意する。ソースコードリーディングを習慣にして変数名、メソッド名を参考にする。Apiリファレンスを参考に変数名、メソッド名を参考にする。メジャーAPIのソースを読み、利用されている変数名、メソッド名を確認し参考にする。クラス「名詞」。パッ

    メソッド名、迷った時に参考にできる単語一覧
  • プログラミングの命名規則ガイドラインを規定するオープンソースプロジェクト「NamingConvention」

    ◆ NamingConvention https://namingconvention.org/ 紹介 「NamingConvention」は、プログラミング命名規則のガイドラインを作成・収集・維持するオープンソースプロジェクトです。 「C#・GitJavaPHPVueJS・Python」が、現在作成進行中です。 Gitの章には、ブランチ名やコミットメッセージ、プルリクのネーミング規定が記載されています。 例えば、ブランチネームだと必須や許可と一緒に例文も記載されています。 プログラミング言語(Java)だと、このようになっています。 推奨のネーミングというより、キャメルケースなど、最低限準拠すべき形式が書かれています。 プログラミング版wikipediaになるような、熱量高いコミュニティが続いて欲しいです。 ◆ NamingConvention https://namingconv

    プログラミングの命名規則ガイドラインを規定するオープンソースプロジェクト「NamingConvention」
  • 【みんなの知識 ちょっと便利帳】アラビア数字、ローマ数字対照表(1〜499)- Arabic numerals / Roman numerals

    1から499までのアラビア数字とローマ数字の対照表です。1から3,999までのページがあります。アラビア数字とローマ数字を変換するプログラムもあります。『みんなの知識 ちょっと便利帳』の一部です。

  • やはりお前らの真偽値メソッド名は間違っている。 〜「Xxx できる?」系メソッドの命名〜 - Qiita

    晒すつもりではありませんが、Facebook で友人のとある投稿を見かけて最初は「三単現にしないと💢」という軽い気持ちで返答したのですが、よくよく考えて見たらこれ思った以上のクソ命名でしたので、とりあえず流れのスクショを上げときます: はい、今回の記事はマサカリです。あしからず。 見ての通り、最初は友人の後輩ちゃんが isCanUseSkill という明らかにアレな命名をしてきたので、友人がそれを指摘をするも、まさかの allowSkill という更にダメな名前をつけてきた件。isCanUseSkill はまだ「なんだこいつの英語はwww」という意図はわかるから笑って済ませそうな名前ですが、allowSkill は「これは命令なのか Yes-Or-No 質問を間違えて命令にしちゃったのか💢」という、書いた人がもし友人じゃなかったら絶対引きずり出して小 1 時間殴りたいレベルのクソ名前

    やはりお前らの真偽値メソッド名は間違っている。 〜「Xxx できる?」系メソッドの命名〜 - Qiita
  • CSSのクラス名を決めるときに使うリストをつくりました

    CSSは設計手法も大事ですが、どういう単語で名前をつけていくかも大事だと思っています。 個人個人でばらつきが出るところでもありますし、「単語名 英語」で検索をして探した単語を使ったけど若干意味合いが違ったといったこともあると思います。 クラス名を決めるためのリストを見かけることもありますが、英単語の読みは書かれていても意味合いが書かれていることは少ないように思います。 自分の確認用と、チームで製作するさいの基準になるようなものを作りたいと思い、単語とその意味を短くまとめてGitHubにあげています。 CSS クラス名リスト | GitHub 以下投稿時の内容です。 名前をつけることは難しいですが、とても重要なことです。 CSSには設計思想が必要ですが、実践するにあたり、名前と機能の意味がとおり、名前のつけ方にブレがないようにするべきです。 このドキュメントでは、CSSでよく使われる単語を分

    CSSのクラス名を決めるときに使うリストをつくりました
  • 相対的なネーミングはよせ、やめるんだ! - Qiita

    たぶん1000回くらいは言われてきているがいまだに絶滅しないので、もう1回言う。ファイル名でもソースコード上の変数でもCSSのセレクタでもなんでもいいけど、相対的なネーミングはやめよう。 Safe Harbor Statement この投稿は個人の(中略)であり、所属する組織とは関係ありません。 なぜ相対的なネーミングをしてはいけないか 名前をつけた人の主観が入り込むため 時間が経つにつれ名前が実態と乖離し混乱を招くため 実装に無駄な制約をかけるため なぜ相対的なネーミングがなくならないか なにが相対的なネーミングなのか理解していないため じゃないかな多分。 避けるべき語 というわけで相対的なネーミングを回避するための禁止ワードのうち代表的なものをあげておきます。 new, 新, latest, 最新, old, 旧 など これらの時系列を表す語は、比較対象がないと新なのか旧なのかわかりま

    相対的なネーミングはよせ、やめるんだ! - Qiita
  • 「~を取得するか否か」というboolean変数の適切な名前

    下記のコードのような「各科目のテスト結果を取得する」メソッドがあった場合、 「英語の点数を取得するか否か」というboolean変数は、どんな名前が適切なのでしょうか? wantEnglishResult変数にしましたが、 動詞から始まるためメソッド名に見える 「want(欲しい)」という曖昧な単語を使っている 点で、不適切だと思います。 かといって、englishやenglishFlagという単語は、trueの場合「取得する」のか「取得しない」のか分からないので、使いたくありません。 適切な名前を教えてください。 ※コードのメソッド設計や引数の名前がよろしくないことは、気にしないでください。 /** * テスト結果を取得する * @param param どの科目を取得するかという情報 */ function getTestResult(param) { var testResult =

    「~を取得するか否か」というboolean変数の適切な名前
  • Boolean型の変数名・メソッド名に主語を含めたい時はどうしたらいいか - Qiita

    前提 Javaを中心に考えています。 他の言語でも大体成り立つ話になるとは思いますが、Rubyとかは怪しいです。 基のおさらい Boolean型の変数名・メソッド名には、以下のような名前がいいと一般的に言われています。 ・isEmpty ・canRead ・hasChanged ・exists これらの名前はif文の中で特に効果を発揮します。 例えば、

    Boolean型の変数名・メソッド名に主語を含めたい時はどうしたらいいか - Qiita
  • プログラミングは「名前」が9割。 - このブログは証明できない。

    プログラミングというのは、名前をつける行為なんだと思う。 プログラミングで一番大切なこと。 もしも、プログラマーじゃない人に、「プログラミングで一番大切なことは?」と聞かれたら、迷わず「名前」だと答える。もちろん、人それぞれだし、自分はスキルの高いプログラマーじゃないよ、と前置きして。 名前が9割と言ったときの、9割という部分は人によってだいぶ差があるんだと思う。もっと小さいかもしれない。けれど、名前が重要だという点に関しては、反対するプログラマーはいないんじゃないだろうか。 時代や環境で変わる名前。 いま僕がイメージしてる名前というのは、変数名だったり関数名だったりクラス名だったり、とにかくいろいろ。さらに、JavaScriptとか高階関数をバリバリ使うような場合など、名前をつけないという選択肢もある。 なんとなくJavaScriptと書いたんだけど、名前はプログラミング言語や開発環境や

    プログラミングは「名前」が9割。 - このブログは証明できない。
  • 可変文字列クラスを MutableString と命名すべき理由 - Qiita

    うまくクラス名を付けるための参考情報といふ記事を見掛けて、「動詞+er」のパターンがちょっと多くていまいちだなーとか思って書いた記事です。 以前クラスの命名のアンチパターンといふ記事を書きましたが、これを読んで「Animation と Animator とではどっちがええんやろ?」と思った人への回答でもあります。 昔の Java では可変文字列クラスは StringBuffer と呼ばれてゐました。C# や最近の Java では可変文字列クラスは StringBuilder と呼ばれます。Objective-C では MutableString です1。 私はこの中では MutableString が最も良いと思ってゐます。次点は StringBuffer です。 StringBuilder はダメです。 MutableString が良い理由は、完全にその名が体を表してゐるからです。直訳

    可変文字列クラスを MutableString と命名すべき理由 - Qiita
  • ダサい名付けから卒業!プログラミングでイケてる関数名・変数名をつけるためのルール+ツール8選 - Findy

    2016.06.06|最終更新:2017.11.17 ダサい名付けから卒業!プログラミングでイケてる関数名・変数名をつけるためのルール+ツール8選 プログラミングをする時に避けては通れないのが関数や変数の名付けです。 複数人で作業する場合は自分が付けた関数名・変数名が他のエンジニアに見られるわけで、分かりにくいものや変な名前を付けるのははばかられます。 記事ではプログラミングの関数名・変数名の名付け問題を解決してくれるツールや情報をまとめました! 1. 正しいコーディングが身につくエンジニア英語の手引き ?文法とクラス/メソッド、命名規則? 正しいコーディングが身につくエンジニア英語の手引き ?文法とクラス/メソッド、命名規則? 英語でプログラミングに最適な名付けをする方法について解説した記事です。複数人で行うプロジェクトでは、「何のためのコードなのか?」が瞬時に連想できるような単語のチ

    ダサい名付けから卒業!プログラミングでイケてる関数名・変数名をつけるためのルール+ツール8選 - Findy
  • 俺が悪かった。素直に間違いを認めるから、もうサービスクラスとか作るのは止めてくれ - Qiita

    ちなみに、最初に結論だけ言っておくと、まずSandi Metzの「オブジェクト指向設計実践ガイド」を読め、という話です それだけで終わってしまいたい気持ちはあるが、不親切過ぎるしもうちょっとRails向けの話を書こうと思う。 ただ言いたいことは、よく分かってないのに使うのは止めろということ。 自分もで書いたりした手前、それが参考にされた結果なのかもしれないが、世の中には当に酷いクラスが存在するもので、雑にサンプルで書くと以下の様な感じのコードが存在したりする。 class HogehogeService # Hogehogeはモデル名まんま def process(hogehoge, option_a: nil, option_b: nil, option_c: false) history = hogehoge.histories.last unless hogehoge.activ

    俺が悪かった。素直に間違いを認めるから、もうサービスクラスとか作るのは止めてくれ - Qiita
  • 「JEPG形式で」の時、前置詞はby?in? - JEPGやCSV形式など電子データを「~形式で保存できます」、と言うと... - Yahoo!知恵袋

    「JEPG形式で」の時、前置詞はby?in? JEPGやCSV形式など電子データを「~形式で保存できます」、と言うときは can be saved by CSV format can be saved in CSV format どちらでしょうか?

    「JEPG形式で」の時、前置詞はby?in? - JEPGやCSV形式など電子データを「~形式で保存できます」、と言うと... - Yahoo!知恵袋
  • Naming -名前付け- - Qiita

    プログラミングで最も重要な技術の一つが、名前付けです。 且つ、センスが問われるものなので、上達は難しいものでもあります。 この記事では、様々な文献から抽出した名前付けに関する情報を雑多にまとめました。 -名前重要- ソフトウェアの設計のアプローチとして、『まず名前から入る』というのは、あまり語られていない秘訣としてもっと広く知られても良いように思います。 - まつもとゆきひろ 『プログラマが知るべき97のこと』 コミュニケーションの基礎 名前は、コミュニケーションの基礎となるものです。 私にもあなたにも名前が無ければ、疎通することは困難になります。 名前をコミュニケーションの基礎と見た場合に重要なルールは以下の通りです。 発音可能であること 検索可能であること ※現実世界のみであれば検索可能じゃなくても良いかも知れません。 プログラミングは、チームや複数人で行うことのほうが多いと思います。

    Naming -名前付け- - Qiita
  • URL設計 画面のURLの命名規則を決めよう Controller名は名詞!で、単数形?複数形? - ビューティフルWebコード

    MVCフレームワークを使ったURL設計についてです。 Controller名は主語! Controllerが主語、Actionが動詞であればそのURLは /Controller名 / Action名 は S(主語)V(動詞)の関係になります。 オブジェクト指向プログラミングでいうところのクラス名、メソッド名も主語、動詞の関係ですよね。 実際に、MVCフレームワークではController名はクラス名、Action名はメソッド名になるので、やはり主語、動詞の関係であるべきです。 Action名については別記事で考察します。 Controller名は主語なんだから名詞! はい、名詞を使ってください。 /beatiful(形容詞)/web /directly(副詞)/access /go(動詞)/home おかしいですよね。 Controller名は単数形なの?複数形なの? 名詞の集合は単数形か

    URL設計 画面のURLの命名規則を決めよう Controller名は名詞!で、単数形?複数形? - ビューティフルWebコード
  • 外国人が語る:英語でクラスやメソッド等の名付け方 - Qiita

    アメリカ人です。 Hello 👋 この記事の目的 多くの日人は自分の英語力には自信がないではないでしょうか。残念ながら「英語がわからん」、「英語が全然できない」という声をしょっちゅう聞いています。でも、今まで英語ができて意味がちゃんと伝わる何人かの日人に会ったがあります。完璧な英語ではないけど(外国人も英語でミスる時もある...)、がんばって話そうとするので充分仕事ができる人たち。そういうがんばる姿勢はオープンソースのプログラムや英語圏のプログラムに手を出すためには一番大事なことだと思います(外国人側もすごく助かります)。日文化では「私はできる!」と自慢することは少ない中、この記事を通して、流暢に話せなくても自分のプログラミングの命名の仕方にはちょっとだけでも自信を持たせたいなと思います。完璧じゃなくていいです。Let's go! 合わせて読んでいただきたい 【日エンジニア

    外国人が語る:英語でクラスやメソッド等の名付け方 - Qiita
  • Englishとは?開発に役立つ使い方、トレンド記事やtips - Qiita

    Englishに関する情報が集まっています。現在350件の記事があります。また278人のユーザーがEnglishタグをフォローしています。

    Englishとは?開発に役立つ使い方、トレンド記事やtips - Qiita
  • 技術英語 Options, Settings, Properties, Configuration, Preferencesの違い - Qiita

    技術英語 Options, Settings, Properties, Configuration, Preferencesの違いEnglish http://stackoverflow.com/questions/2074384/options-settings-properties-configuration-preferences-when-and-why によれば、Visual Studioのガイドでは下記の通りらしい。 Properties(プロパティ)一つのコンポーネントまたはオブジェクトの特性を表すもの Options(オプション)グローバルな振る舞いを変えるもの。無効にできるというニュアンス Settings(設定)とPreferences(ユーザー設定)複数の選択肢があり、無効化するものではないというニュアンス Configuration(構成)ユーザー向けにカスタマイズ

    技術英語 Options, Settings, Properties, Configuration, Preferencesの違い - Qiita
  • Webサイトのディレクトリ構造とその命名規則に悩む - Qiita

    Webサイトのディレクトリ構造とその命名って、特に決まりがなくて迷う 筆者は英語についてはほとんどよく知らないため、完全な独断による記事。 ただし、できるだけモヤモヤしないことを優先し、筋が通っていそうなルールを目指す。 画像・スクリプト・スタイルシート等をHTMLと分けて入れるフォルダの名前をどうするか? よくある名前 ルート直下に「HTML以外をまとめるフォルダ」を作るときは、 特に決まりはないが、だいたい以下のような名前が多いと思う。 assets, public, module, modules, common, commons, resource, resources それぞれの単語の意味合いをまとめまた。リンクをクリックするとweblio辞書に飛ぶ assets:複数形で 個人・会社の 財産・資産 public: 公開の・共有の modules:モジュール commons:共通

    Webサイトのディレクトリ構造とその命名規則に悩む - Qiita
  • state と status の違い - Qiita

    コンピュータの世界では、state と status はどちらも、状態を表します。 ステータスバー StatusBar 現在の状態などを表示する帯状の部分 デザインパターン Stateパターン 状態に応じて処理内容を切り替える 変数名などで state と status はどう使い分ければ良い? http://www.atmarkit.co.jp/bbs/phpBB/viewtopic.php?topic=46846&forum=3 state, status and condition : 状態と条件 http://lise-sophia.net/kktm/Essay/state_status_condition.htm status : 状態を表す情報の入れ物(変数) state : 具体的な個別の状況(statusに入りうる状態の1つ) 私もそのような認識をしています。

    state と status の違い - Qiita