@@ -812,16 +812,16 @@ public void onMouseMove(Widget sender, int x, int y) { .. }
812812이러한 규칙을 따르면 시간과 좌절감을 줄일 수 있다.
813813
814814:::success
815- <b > 개인적인 생각 & 정리</b > < br />
816- 의무적인 Javadoc 은 없어도 된다. <b > (Clean Code Bad Comments 6, 7, 18) </b > < br />
817- API 중에서 특수한 경우 (parameter 에 대한 주석이 필요할 때) Javadoc 으로 작성하면 가독성이 좋다. < br />
818- → (반드시 best practices 를 따를 필요는 없으므로!!) < br />
819- 설명이나 정보를 알려주는 주석은 반드시 필요하다. <b > (Clean Code Good Comments 2, 3, 4) </b > < br />
820- → 혼란을 야기하는 내용은 안된다. <b > (Best Practices for writing code comments 규칙 4) </b > < br />
821- → 너무 많은 정보를 담지 않아야 한다. <b > (Clean Code Bad Comments 15) </b > < br />
822- TODO 주석은 필요한 경우만 달자. <b > (Clean Code Good Comments 6) </b > < br />
823- 참고한 코드의 링크를 추가하는 것이 좋다. <b > (Best Practices for writing code comments 규칙 6, 7) </b > < br />
824- 버그로 인한 수정할 때 주석을 추가 하자. <b > (Best Practices for writing code comments 규칙 8) </b > < br />
815+ <b > 개인적인 생각 & 정리</b >
816+ 의무적인 Javadoc 은 없어도 된다. <b > (Clean Code Bad Comments 6, 7, 18) </b >
817+ API 중에서 특수한 경우 (parameter 에 대한 주석이 필요할 때) Javadoc 으로 작성하면 가독성이 좋다.
818+ → (반드시 best practices 를 따를 필요는 없으므로!!)
819+ 설명이나 정보를 알려주는 주석은 반드시 필요하다. <b > (Clean Code Good Comments 2, 3, 4) </b >
820+ → 혼란을 야기하는 내용은 안된다. <b > (Best Practices for writing code comments 규칙 4) </b >
821+ → 너무 많은 정보를 담지 않아야 한다. <b > (Clean Code Bad Comments 15) </b >
822+ TODO 주석은 필요한 경우만 달자. <b > (Clean Code Good Comments 6) </b >
823+ 참고한 코드의 링크를 추가하는 것이 좋다. <b > (Best Practices for writing code comments 규칙 6, 7) </b >
824+ 버그로 인한 수정할 때 주석을 추가 하자. <b > (Best Practices for writing code comments 규칙 8) </b >
825825변수 명이나 메서드 명을 명확히 한다면 주석을 작성하는 일이 줄어 들 것 같다...!
826826:::
827827
0 commit comments