Skip to content

Commit b7df05c

Browse files
committed
주석 part3
1 parent 9b51b89 commit b7df05c

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

4. 주석/Readme.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,5 +185,63 @@ if (moduleDependees.contains(ourSubSystem))
185185

186186

187187
7. 닫는 괄호에 다는 주석
188+
-> 아무의미 없으니, 이럴 필요를 느낀다면 함수를 개선해보자.
189+
190+
191+
192+
8. 공로를 돌리거나 저자를 표시하는 주석
193+
```
194+
/* 이한위 2021.02.28 추가함수*/
195+
```
196+
-> 어짜피 git에서 저장이된다. 이런거 하지말고 커밋로그나 잘 쓰자
197+
198+
199+
200+
9. 주석으로 처리한 코드
201+
```
202+
//var myTestVar: Float = 3
203+
//...
204+
//...
205+
```
206+
-> 이런식으로 코드가 주석처리가 되어있으면 사람들이 이 주석을 지우기를 주저한다. 왜? 필요할지 모른다는 생각을 하기때문에
207+
-> 어짜피 git 상에 남게됨으로 걱정하지말고 지워도 된다. 그냥 지워라
208+
209+
210+
211+
10. HTML주석
212+
-> 걍 극혐
213+
214+
215+
216+
11. 전역 정보
217+
```
218+
/*
219+
적합성 테스트가 동작하는 포트: 기본값은 <b>8082</b>
220+
@param fitnessPort
221+
*/
222+
public void setFitnessPort(int fitnessePort {
223+
this.fitnessPort = fitnessPort;
224+
}
225+
```
226+
-> 주석은 오로지 이 주석에 해당하는 정보만을 담아야 좋다. 위와같이 기본값이 뭐니 이런정보는 ㄴㄴ
227+
228+
229+
230+
12. 너무 많은 정보
231+
-> 너무나 TMI면 안됨. 정말 필요한 정보만 주석으로 남겨놓자
232+
233+
234+
235+
13. 모호한 관계
236+
```
237+
/*
238+
모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다).
239+
그리고 헤더 정보를 위해 200바이트를 더한다.
240+
*/
241+
this.pngBytes = new byte[((this.width + 1) * this.height * 3) + 200]
242+
```
243+
-> 도대체 필터바이트가 뭔지, this.width와 this.height중에 필터바이트가 뭔지..... 주석자체에 주석을 달아야할 지경
244+
245+
188246

189247

0 commit comments

Comments
 (0)