30
Help us understand the problem. What are the problem?

More than 5 years have passed since last update.

posted at

updated at

良いコードのためのメモ

命名

省略のコツ

  • 先頭の数文字以外削除 (Separetors -> Seps)
  • ingの削除 (Grouping -> Group)
  • 単語の削除 (formattedConsumptionTax -> formattedTax)
  • 母音を削除 (image -> img)
  • 強い音以外削除 (server -> svr)
  • 汎用略語 (database -> db)

略語検索サイト
Abbreviations and acronyms dictionary: Find definitions for over 4,219,000 abbreviations, acronyms, and initialisms

英語を正しく使う

日本人が勘違いしている単語があるので、気をつける。
例)regist -> register
※registという単語は存在しない

誤訳に注意

  • 機械翻訳した単語を使うのは危険
  • 意味を取り違えた単語を使うと将来のバグの元

単語検索/辞典
英語・語学の学習情報サイト「スペースアルク」:アルク

流行

命名方法にも流行り廃りがあるので、時流に合わせた方法を学ぶ。

変数名

  • スコープが長いほど、より具体的な名前に。
  • メソッドの引数は簡潔に
  • 説明的な名前にする(何の(ための)○○ )
ダメな例
var languages = ['ja', 'en'];
良い例
var availableLanguages = ['ja', 'en'];

メソッド名

  • 動詞 + 目的語 (getXXX)
  • 良く使うメソッドは簡潔で短い方が良い

クラス名

  • クラス名がなかなか決まらない時は設計を疑う
  • クラス名の命名 = 設計 = 経験値が重要

習熟度別よく使われるクラス名

       作業範囲            クラス名    
レベル1 アプリ開発           Action,Controller,Model,Helper,Test
レベル2 プラグイン/アドオン開発    Plugin,Adaptor,Factory,Handler,Builder
レベル3 フレームワーク/ライブラリ開発 Loader, Cache, Engine, Descriptor

スコープ

変数宣言

  • スコープを極力短くするため、変数は使用する直前に宣言する。

参考書籍

Amazon.co.jp: 良いコードを書く技術 -読みやすく保守しやすいプログラミング作法 (WEB+DB PRESS plus): 縣 俊貴: 本

Register as a new user and use Qiita more conveniently

  1. You can follow users and tags
  2. you can stock useful information
  3. You can make editorial suggestions for articles
What you can do with signing up
30
Help us understand the problem. What are the problem?