Skip to content

Commit d038b41

Browse files
committed
No journal comments
1 parent c62367f commit d038b41

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -956,3 +956,28 @@ doStuff();
956956
doStuff();
957957
```
958958
**[⬆ back to top](#table-of-contents)**
959+
960+
### Don't have journal comments
961+
Remember, use version control! There's no need for dead code, commented code,
962+
and especially journal comments. Use `git log` to get history!
963+
964+
**Bad:**
965+
```javascript
966+
/**
967+
* 2016-12-20: Removed monads, didn't understand them (RM)
968+
* 2016-10-01: Improved using special monads (JP)
969+
* 2016-02-03: Removed type-checking (LI)
970+
* 2015-03-14: Added combine with type-checking (JR)
971+
*/
972+
function combine(a, b) {
973+
return a + b;
974+
}
975+
```
976+
977+
**Good**:
978+
```javascript
979+
function combine(a, b) {
980+
return a + b;
981+
}
982+
```
983+
**[⬆ back to top](#table-of-contents)**

0 commit comments

Comments
 (0)