Skip to content

Commit 05aaff1

Browse files
author
Misaki Shibata
authored
Update README.md
1 parent d4cb67d commit 05aaff1

File tree

1 file changed

+4
-29
lines changed

1 file changed

+4
-29
lines changed

README.md

Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -970,9 +970,9 @@ review.perfReview();
970970

971971
## **Comments**
972972

973-
### ビジネスロジックが複雑なものにのみコメントすること
973+
### ロジックが複雑なものにのみコメントすること
974974

975-
コメントは弁明です、必須ではありません。良いコードは *ほとんどが* ドキュメントそのものです
975+
良いコードはドキュメントそのものです
976976

977977
**Bad:**
978978
```javascript
@@ -1014,9 +1014,9 @@ function hashIt(data) {
10141014
```
10151015

10161016

1017-
### コメントアウトしたコードをコードベースに残さない
1017+
### コメントアウトしたコードを残さない
10181018

1019-
バージョン管理があることがその理由です。古いコードは履歴に残しましょう
1019+
バージョン管理があるなら古いコードは履歴に残しましょう
10201020

10211021
**Bad:**
10221022
```javascript
@@ -1032,31 +1032,6 @@ doStuff();
10321032
```
10331033

10341034

1035-
### 日記のようなコメントは持たない
1036-
特に日記の様なコメント。
1037-
履歴を取得するためには `git log` を使ってください!
1038-
1039-
**Bad:**
1040-
```javascript
1041-
/**
1042-
* 2016-12-20: Removed monads, didn't understand them (RM)
1043-
* 2016-10-01: Improved using special monads (JP)
1044-
* 2016-02-03: Removed type-checking (LI)
1045-
* 2015-03-14: Added combine with type-checking (JR)
1046-
*/
1047-
function combine(a, b) {
1048-
return a + b;
1049-
}
1050-
```
1051-
1052-
**Good:**
1053-
```javascript
1054-
function combine(a, b) {
1055-
return a + b;
1056-
}
1057-
```
1058-
1059-
10601035
### JavaScriptで書いたコードを公開する際に気をつけること
10611036

10621037
JavaScriptはブラウザでそのまま実行されるので、書いたコードは丸見えになっています。

0 commit comments

Comments
 (0)