Download as PDF, PPTX
![25
EditorConfig
プロジェクトでのエディタの設定を共有できる
[*]
charset = utf-8
end_of_line = lf
trim_trailing_whitespace = true
indent_style = space
indent_size = 2
[*.js]
indent_style = space
indent_size = 2
[Makefile]
indent_style = tab
indent_size = 4](https://image.slidesharecdn.com/for-writing-clean-code-160701103059/75/For-writing-clean-code-25-2048.jpg)
![33
ゆとりを持つ
<?php
/*認証 必要 読 込 */
require_once( 'twitter/' .'config.php');
require_once( 'twitter/' .'twitteroauth.php');
session_start();
// getToken.php oauth_token 一致
if ($_SESSION['oauth_token'] !== $_REQUEST['oauth_token']) {
unset($_SESSION);
echo '<a href="getToken.php">token不一致</a>';
exit;
}
// access token 取得
$tw = new TwitterOAuth(CONSUMER_KEY, CONSUMER_SECRET,
$_SESSION['oauth_token'], $_SESSION['oauth_token_secret']);
$access_token = $tw->getAccessToken($_REQUEST['oauth_verifier']);
// Twitter user_id + screen_name(表示名)
$_SESSION['user_id'] = $access_token['user_id'];
$_SESSION['screen_name'] = $access_token['screen_name'];
include('db_connection.php');
$sql = 'SELECT * FROM user_data WHERE user_id = ' . $_SESSION['user_id'
$query = mysql_query($sql, $link);](https://image.slidesharecdn.com/for-writing-clean-code-160701103059/75/For-writing-clean-code-33-2048.jpg)
![34
適切な改行とスペース
<?php
// 認証 必要 読 込
require_once('twitter/' . 'config.php');
require_once('twitter/' . 'twitteroauth.php');
session_start();
// getToken.php oauth_token 一致
if ($_SESSION['oauth_token'] !== $_REQUEST['oauth_token']) {
unset($_SESSION);
echo '<a href="getToken.php">token不一致</a>';
exit;
}
// access token 取得
$tw = new TwitterOAuth(
CONSUMER_KEY,
CONSUMER_SECRET,
$_SESSION['oauth_token'],
$_SESSION['oauth_token_secret']
);
$access_token = $tw -> getAccessToken($_REQUEST['oauth_verifier']);](https://image.slidesharecdn.com/for-writing-clean-code-160701103059/75/For-writing-clean-code-34-2048.jpg)
![{
"status": 0,
"player_data": {
"player_name": "Name",
"total_score": "394262836",
"rank": 3083,
"average_score": "851539",
}
}
// GET 取得 JSON 列挙
request.get(URL, function(error, response, body) {
if (!error) {
let json = JSON.parse(body);
if (json.status === 0) {
let playerData = json["player_data"];
for (let p in playerData) {
if (playerData[p] !== null) {
console.log(p + " is " + playerData[p]);
}
}
}
}
});](https://image.slidesharecdn.com/for-writing-clean-code-160701103059/75/For-writing-clean-code-48-2048.jpg)
![// GET 取得 JSON 列挙
request.get(URL, function(error, response, body) {
if (error) {
return;
}
let json = JSON.parse(body);
if (json.status !== 0) {
return;
}
let playerData = json["player_data"];
for (let p in playerData) {
if (playerData[p] === null) {
continue;
}
console.log(p + " is " + playerData[p]);
}
});](https://image.slidesharecdn.com/for-writing-clean-code-160701103059/75/For-writing-clean-code-50-2048.jpg)
![64
一時変数をメソッドや関数で置き換える
let exists = false;
for (let i = 0; i < BLACK_LIST.length; i++) {
if (person.name === BLACK_LIST[i]) {
exists = true;
break;
}
}
if (exists) {
// BAN
} else {
// 一般人 時 処理
}](https://image.slidesharecdn.com/for-writing-clean-code-160701103059/75/For-writing-clean-code-64-2048.jpg)
![65
メソッドに抽出する
function isExists(person.name) {
let exists = false;
for (let i = 0; i < BLACK_LIST.length; i++) {
if (person.name === BLACK_LIST[i]) {
exists = true;
break;
}
}
return exists;
}
↓
function isMarkedPerson(name) {
for (let i = 0; i < BLACK_LIST.length; i++) {
if (name === BLACK_LIST[i]) {
return true;
}
}
return false;
}](https://image.slidesharecdn.com/for-writing-clean-code-160701103059/75/For-writing-clean-code-65-2048.jpg)
More Related Content
Similar to わかるコードを書くために For writing clean code
わかるコードを書くために For writing clean code
- 1.
- 2. 2 $ whoami 青木太郎 Eyes, JAPAN/ ヅ大2年目 Groove Coaster STEINS;GATE 色々...
- 3. 3 わからないコード s = a(p.h); functiona(b) { return b * 900 + 4000; }
- 5. 4 5 目次 1. 目的 2. 表面の改善 3.内面の改善 4. まとめ
- 6.
- 7.
- 8.
- 9.
- 10.
- 11.
- 12.
- 13.
- 14.
- 15.
- 16.
- 18. 17 18 代表的な表記法 名前 例 アッパーキャメルケース(UCC) ExampleString ローワーキャメルケース(LCC)exampleString スネークケース example_string ハンガリアン記法 mExampleString
- 19. 19 わりと一般的な命名規則の例 名前 表記 例 クラスUCC class ImageUtil {...} 変数、メンバ変数 LCC or スネークケース let imageTitle; 関数、メソッド LCC function fetchImageTitle() {...} 定数 大文字+ スネークケース const MAX_STRING;
- 20.
- 21. 21 細かな違い if (example.isTrue) { ... }else { ... } if(example.isTrue) { ... } else { ... } if (example.isTrue) { ... } else { ... }
- 22.
- 23.
- 24.
- 25. 25 EditorConfig プロジェクトでのエディタの設定を共有できる [*] charset = utf-8 end_of_line= lf trim_trailing_whitespace = true indent_style = space indent_size = 2 [*.js] indent_style = space indent_size = 2 [Makefile] indent_style = tab indent_size = 4
- 26. let s =a(p.h); function a(b) { return b * 900 + 4000; } let salary = getSalary(person.hours); function getSalary(hours) { return hours * 900 + 4000; }
- 27.
- 28. 28 関数やメソッドの命名パターンの一例 パターン プレフィックス 例 getter/ setter get / set getText(), setText() boolean is, can, has isEmpty() 外部から取得する fetch fetchImageTitle() イベント発生時 on onItemClick()
- 29. 29 明確な名前をつける let salary =getSalary(person.hours); function getSalary(hours) { return hours * 900 + 4000; } let salary = computeSalary(person.workedHours); function computeSalary(workedHours) { return workedHours * 900 + 4000; }
- 30. 30 ロジックを確認しなくても把握しやすい let salary =computeSalary(person.workedHours);
- 31. 31 スコープと命名 スコープと変数の持つ意味を考える void swap(int *a,int *b) { int tmp; tmp = *a; *a = *b; *b = tmp; }
- 32.
- 33. 33 ゆとりを持つ <?php /*認証 必要 読込 */ require_once( 'twitter/' .'config.php'); require_once( 'twitter/' .'twitteroauth.php'); session_start(); // getToken.php oauth_token 一致 if ($_SESSION['oauth_token'] !== $_REQUEST['oauth_token']) { unset($_SESSION); echo '<a href="getToken.php">token不一致</a>'; exit; } // access token 取得 $tw = new TwitterOAuth(CONSUMER_KEY, CONSUMER_SECRET, $_SESSION['oauth_token'], $_SESSION['oauth_token_secret']); $access_token = $tw->getAccessToken($_REQUEST['oauth_verifier']); // Twitter user_id + screen_name(表示名) $_SESSION['user_id'] = $access_token['user_id']; $_SESSION['screen_name'] = $access_token['screen_name']; include('db_connection.php'); $sql = 'SELECT * FROM user_data WHERE user_id = ' . $_SESSION['user_id' $query = mysql_query($sql, $link);
- 34. 34 適切な改行とスペース <?php // 認証 必要読 込 require_once('twitter/' . 'config.php'); require_once('twitter/' . 'twitteroauth.php'); session_start(); // getToken.php oauth_token 一致 if ($_SESSION['oauth_token'] !== $_REQUEST['oauth_token']) { unset($_SESSION); echo '<a href="getToken.php">token不一致</a>'; exit; } // access token 取得 $tw = new TwitterOAuth( CONSUMER_KEY, CONSUMER_SECRET, $_SESSION['oauth_token'], $_SESSION['oauth_token_secret'] ); $access_token = $tw -> getAccessToken($_REQUEST['oauth_verifier']);
- 35.
- 36. 36 マジックナンバーは敵 let salary =computeSalary(person.workedHours); function computeSalary(workedHours) { return workedHours * 900 + 4000; }
- 37.
- 38. 38 マジックナンバーの置き換え let salary =computeSalary(person.workedHours); function computeSalary(workedHours) { return workedHours * 900 + 4000; } let salary = computeSalary(person.workedHours); function computeSalary(workedHours) { const BASE_SALARY = 4000; const HOURLY_PAYMENT = 900; return workedHours * HOURLY_PAYMENT + BASE_SALARY; }
- 39.
- 40. 40 不要なコメント // 引数 定数倍返 function multiple(number) { const MULTIPLIER = 5; return number * MULTIPLIER; }
- 41. 41 不要なコメント(補助的なコメント) // 楽曲 名前取得 function getMusicList() { ... return musicList; } function fetchAllMusicName() { ... return musicNameList; }
- 42. 42 適切なコメント(新たな情報を伝えている) // 10秒未満 制限掛 const SLEEP_TIME = 10
- 43.
- 44.
- 45.
- 46.
- 47.
- 48. { "status": 0, "player_data": { "player_name":"Name", "total_score": "394262836", "rank": 3083, "average_score": "851539", } } // GET 取得 JSON 列挙 request.get(URL, function(error, response, body) { if (!error) { let json = JSON.parse(body); if (json.status === 0) { let playerData = json["player_data"]; for (let p in playerData) { if (playerData[p] !== null) { console.log(p + " is " + playerData[p]); } } } } });
- 49.
- 50. // GET 取得JSON 列挙 request.get(URL, function(error, response, body) { if (error) { return; } let json = JSON.parse(body); if (json.status !== 0) { return; } let playerData = json["player_data"]; for (let p in playerData) { if (playerData[p] === null) { continue; } console.log(p + " is " + playerData[p]); } });
- 51.
- 52. 52 例えば… if (serverA.status !==0 && serverB.status !== 0) { // A B 異常 時 処理 } else if (serverA.status !== 0 && serverB.status === 0) { // A 異常 時 処理 } else if (serverA.status === 0 && serverB.status !== 0) { // B 異常 時 処理 }
- 53. if (serverA.status !==0) { if (serverB.status !== 0) { // A B 異常 時 処理 } else { // A 異常 時 処理 } } else { if (serverB.status !== 0) { // B 異常 時 処理 } }
- 54.
- 55. 54 55 分かりづらい条件分岐 if (serverA.status !==0 && serverB.status !== 0) { // A B 異常 } else if (serverA.status !== 0) { // A 異常 } else if (serverB.status !== 0) { // B 異常 }
- 56.
- 57. 57 分かりづらい条件分岐をメソッドで置き換える // public boolean isStatusError(){ if (status !== 0) { return false; } return true; } if (serverA.isStatusError() && serverB.isStatusError()) { // A B 異常 } else if (serverA.isStatusError()) { // A 異常 } else if (serverB.isStatusError()) { // B 異常 }
- 58.
- 59.
- 60.
- 61.
- 62.
- 63.
- 64. 64 一時変数をメソッドや関数で置き換える let exists =false; for (let i = 0; i < BLACK_LIST.length; i++) { if (person.name === BLACK_LIST[i]) { exists = true; break; } } if (exists) { // BAN } else { // 一般人 時 処理 }
- 65. 65 メソッドに抽出する function isExists(person.name) { letexists = false; for (let i = 0; i < BLACK_LIST.length; i++) { if (person.name === BLACK_LIST[i]) { exists = true; break; } } return exists; } ↓ function isMarkedPerson(name) { for (let i = 0; i < BLACK_LIST.length; i++) { if (name === BLACK_LIST[i]) { return true; } } return false; }
- 66. 66 呼び出し側 if (isMarkedPerson(person.name)) { //BAN } else { // 一般人 時 処理 }
- 67.
- 68.
- 69.
- 70.
- 71. 71 車 名前 例 クラス 設計図 メソッド機能 メンバ 状態(速度) インスタンス 実際の車
- 72.
- 73.
- 74.
- 75.
- 76. 76 メンバ変数を一つにまとめる String firstName, lastName,email, nickname; int gender; firstName = json.getString("firstName"); lastName = json.getString("lastName"); email = json.getString("email"); nickname = json.getString("nickname"); gender = Integer.parseInt(json.getString("gender"));
- 77. 77 データクラス class Profile { privateString firstName, lastName, email, nickname; private Gender gender; Profile(String firstName, String lastName, String email, String nicknam this.firstName = firstName; this.lastName = lastName; this.email = email; this.nickname = nickname; this.gender = gender; } // getter & setter }
- 78. 78 呼び出し側 Profile profile =new Profile( json.getString("firstName"), json.getString("lastName"), json.getString("email"), json.getString("nickname"), Integer.parseInt(json.getString("gender")) ); profile.getFirstName();
- 79.
- 80. 80 null オブジェクトの利用 public classPartTimeStudent { private String firstName, ..., email, hireDate; // 下 ParensHome 利用 // 住民票 実家 場合 private ParentsHome parentsHome; // getter & setter } class ParentsHome { private String phoneNumber; private String address; private String representative; public String getPhoneNumber() { return phoneNumber; } // getter & setter }
- 81. 81 if やswitch を多用せざるを得ない if(exampleStudent.getParentsHome() === null) { System.out.println("実家 電話番号: -"); } String phoneNumber = exampleStudent.getParentsHome().getPhoneNumber(); System.out.println("実家 電話番号: " + phoneNumber);
- 82. 82 1. nullオブジェクトの追加 class NullParentsHomeextends ParentsHome { ... }
- 83. 83 2. isNull() の追加 classParentsHome { private String phoneNumber; private String address; private String representative; public boolean isNull() { return false; } public String getPhoneNumber() { return this.phoneNumber; } ... } class NullParentsHome extends ParentsHome { @Override public boolean isNull() { return true; } ... }
- 84. 84 3. PartTimeStudent クラスの呼び出し元の修正 publicclass PartTimeStudent { ... ParentsHome getParentsHome() { return parentsHome; } ... } ↓ public class PartTimeStudent { ... ParentsHome getParentsHome() { if (parentsHome === null) { return new NullParentsHome(); } return parentsHome; } ... }
- 85. 85 4. null 判定箇所をisNull()で置き換え、テストする if (exampleStudent.getParentsHome() === null) { return; } if (exampleStudent.getParentsHome().isNull()) { return; }
- 86. 86 5. ParentsHome がnullの時のgetter の値を設ける class NullParentsHome extends ParentsHome { @Override public boolean isNull() { return true; } @Override public String getPhoneNumber() { return "-"; } ... }
- 87. 87 6. if を削除できる if(exampleStudent.getParentsHome() === null) { return; } String phoneNumber = exampleStudent.getParentsHome().getPhoneNumber(); System.out.println("実家 電話番号: " + phoneNumber); ↓ String phoneNumber = exampleStudent.getParentsHome().getPhoneNumber(); System.out.println("実家 電話番号: " + phoneNumber); 出力 実家 電話番号: 0000-11-2222 実家 電話番号: -
- 88.
- 89.
- 90.
- 91.
- 92.
- 93.
- 94.
- 95.
- 96.
- 97. 97 出典(スライド内で使用した画像) ヴォイニッチ手稿: 青峰: アニメ黒子のバスケ2期OP TABS vsSPACES: Emacs vs Vim: どうしてこうなった: 2ちゃんねるAA FXで有り金全部溶かした人の顔: あいまいみー第9話 やらなければ、一生わからん！！: 燃えよペン Voynich Manuscript Truly Code 4.bp.blogspot.com