リーダブルコードが良書だったのでまとめました

リーダブルコード
が良書だったのでまとめました

リーダブルコードとは？
リーダーぶる行動？
寄り目のバイトリーダーの
マネジメント術とかそんなの

リーダブルコードとは？
じゃないです

よいコードってなに？
♯ 拡張性
♯ 再利用性
♯ 開発速度
♯ 可読性 <- 今回のテーマはこれ
♯ パフォーマンス
♯ セキュリティ

リーダブルなコードとは？
新しいプロジェクトのメンバーが
理解するまでにかかる時間が少ないコード
※理解するというのは変更を加えたりバグを見つけ
たり出来るという意味。

コードを読みやすくするために
♯ 表面上の改善 <- すぐ出来て効果が高い
♯ コードの再構成

表面上の改善
♩ 名前に意味を込める
♩ 誤解されない名前
♩ 読みやすいフォーマット
♩ 分かりやすいコメント

名前に意味を込める -1-
buildTaxUtils()
generateTaxUtils()
事前に設定が必
要
新しいオブジェ
クトを作る
filter()
select()
exclude()
選択
除外
♪ メソッドには具体的な名前をつかう
makeTaxUtils()

delay
fileSize
delay_secs
size_mb
plaintext_password
unescaped_commen
password
comment
♪ 変数に単位をつける
♪ その他情報を追加する

OK : document -> doc
string -> str
NG : TTPCommonUtils
well knownな略
語
ディルバートを
読んでないと分
からない
♪ 頭文字と省略形

誤解されない名前
- get や size は軽い処理だと思われる
- 限界地を含めるときは min, max
- 範囲をしているときは first, last
- 包含、排他的範囲には begin, end
♪ 習慣的な名前

読みやすいフォーマット -1-
// 超過労働者チェック
List<String> overworker = employeeList.stream().filter(employee -> employee.getWorkTime >
200).sorted(Comparator.comparingInt(Employee::getEmployeeId)).map(Employee::getName).collect(C
ollectors.toList());
// 超過労働者チェック
List<String> overworker = employeeList.stream()
.filter(employee -> employee.getWorkTime > 200)
.sorted(Comparator.comparingInt(Employee::getEmployeeId))
.map(Employee::getName)
.collect(Collectors.toList());
✖
♪ 適当な改行

//データを配列化する
$data = array(
'monthly_report_id' => $dailyReportList[0]['monthly_report_id'],
'monthly_report_apply_status' => CELLAR_MONTHLY_REPORT_APPLY_STATUS_APPLIED,
'attendance_count' => $attendanceCount,
'working_hours' => $totalWorkingHours,
'holiday_working_hours' => $totalHolidayWorkingHours,
'midnight_working_hours' => $totalMidnightWorkingHours,
'paid_holiday_count' => $paidHolidayCount,
);
✖
♪ 縦の線をそろえる

//データを配列化する
$data = array(
'monthly_report_id' => $dailyReportList[0]['monthly_report_id'],
'monthly_report_apply_status' => CELLAR_MONTHLY_REPORT_APPLY_STATUS_APPLIED,
'attendance_count' => $attendanceCount,
'working_hours' => $totalWorkingHours,
'holiday_working_hours' => $totalHolidayWorkingHours,
'midnight_working_hours' => $totalMidnightWorkingHours,
'paid_holiday_count' => $paidHolidayCount,
);
♪ 縦の線をそろえる

$employeeId = $this->data["employee_id"];
$expenses = $this->data["expenses"];
$route = $this->data["route"];
$facility = $this->data["facility"];
$reportId = $this->data["monthly_report_id"];
$monthlyData = array('employee_id' => $employeeId,
'monthly_report_id' => $reportId,
'regular_transport_expenses' => $expenses,
'regular_transport_route' => $route,
'regular_transport_facility' => $facility,
);
✖
♪ 順番を守る

File inputFile = new File(input_file_name);
FileReader filereader = new FileReader(inputFile);
BufferedReader br = new BufferedReader(filereader);
String dateText = br.readLine();
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy/MM/dd HH:mm:ss");
LocalDateTime localDateTime = LocalDateTime.parse(dateText, formatter);
String futureDate = localDateTime.plusDays(3).toString();
File outputFile = new File(output_file_name);
PrintWriter pw = new PrintWriter(new BufferedWriter(new FileWriter(outputFile)));
pw.println(futureDate);
✖
♪ 段落を分ける

// extract
File inputFile = new File(input_file_name);
FileReader filereader = new FileReader(inputFile);
BufferedReader br = new BufferedReader(filereader);
String dateText = br.readLine();
// transform
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy/MM/dd HH:mm:ss");
LocalDateTime localDateTime = LocalDateTime.parse(dateText, formatter);
String futureDate = localDateTime.plusDays(3).toString();
// load
File outputFile = new File(output_file_name);
PrintWriter pw = new PrintWriter(new BufferedWriter(new FileWriter(outputFile)));
pw.println(futureDate);
♪ 段落を分ける

@test
public void test(){
List<Employee> empList = new ArrayList<>();
Employee emp = new Employee();
emp.setName(“sato”);
emp.setAge(10);
emp.setAdministrative(false);
empList.add(emp);
emp = new Employee();
emp.setName(“yamada”);
emp.setAge(30);
emp.setAdministrative(false);
empList.add(emp);
...
}
✖
♪ ヘルパーメソッドの導入

@test
public void test(){
List<Employee> empList = new ArrayList<>();
// name age admin
empList.add(empHelper(“sato”, 10, false));
empList.add(empHelper(“yamada”, 30, false));
...
}
private Employee empHelper(String name, int age, boole admin) {
Employee emp = new Employee();
emp.setName(name);
emp.setAge(age);
emp.setAdministrative(admin);
return emp;
}
♪ ヘルパーメソッドの導入

分かりやすいコメント -1-
/**
* 金額を扱う為のクラスです。
* 通貨換算、税、丸めなどの機能を提供します。
* Java1.3用に標準APIを移植しました。
* このためJPY,USDにしか対応していません。
*/
public interface MonetaryAmount extends CurrencySupplier, NumberSupplier,
Comparable<MonetaryAmount>{
...
}
♪ ファイルやメソッドには全体像のコメントする

// トランザクションの開始
$transaction->begin($dbh);
✖
♪ コードからすぐに分かることは書かない

// 月報情報の取得
$trafficExpenses = WorkReportService::findWorkReport(
$employeeId, $year, $month, $this->errorMessageList);
// findWorkReportはデータが存在しない場合、データをDBに登録してその値を返します
※findWorkReportは
データが存在しない場合、新規にデータを登録してその値を返す実装
✖
♪ 読み手が驚くような動作はコメントする

$trafficExpenses = WorkReportService::selecsertWorkReport(
✖
♪ ひどい名前はコメントではなく名前を変える

'first_name' => array(
'ruleNotEmpty' => array(
'rule' => 'notEmpty',
'message' => E_MESSAGE_FIRST_FAMILY_NAME_EMPTY
),
'ruleMaxLength' => array(
// FIXME 4バイト以上のUnicode文字を入力されるとDB登録時にエラーになる
'rule' => array('maxLength', '8'),
'message' => E_MESSAGE_FIRST_FAMILY_NAME_LENGTH
)
♪ コードの欠陥にコメントをつける

# コネクションプールの設定
driverClassName=oracle.jdbc.driver.OracleDriver
url=jdbc:oracle:thin:@localhost:1521/xe
username=alibaba
password=0pen5esame
# 出社のピーク時だけ負荷が高いのでmaxActiveは社員数の80%、普段は出社ピークでも最大30接続程度
initialSize=5
maxActive=50
maxIdle=5
maxWait=5000
validationQuery=select count(*) from dual
♪ 設定値にコメントをつける

まとめ
♯ 変数・関数は性質を現している名前にする
♯ コメントは読む人の助けになるか考えて書く

リーダブルコードが良書だったのでまとめました

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (20)

Similar to リーダブルコードが良書だったのでまとめました

Similar to リーダブルコードが良書だったのでまとめました (20)

Recently uploaded

Recently uploaded (7)

リーダブルコードが良書だったのでまとめました

Editor's Notes