본문 바로가기
개발관련/도서추천

[개발자의 글쓰기] 주석 작성

by 득당 2021. 12. 7.

개발자의 글쓰기란 책을 우연히 발견하고, 아주 재밋게 보았고, 여러모로 도움이 됨

코드를 작성하는 사람에게는 유용할것 같아 추천한다.

 

/*
TODO: 가장 중요하게 해야 할 일이다.

ToDo: 할 일이다.

toDo: 하면 좋은 일이다.

todo: 해야 할지 말지 판단하라.


'FIXME'도 같은 식으로 표현할 수 있다.

FIXME: 버그를 지금 당장 고쳐라.

FixMe: 버그를 고쳐라.

fixMe: 버그를 고지는 것이 낫다

fixme: 버그지만 고쳐야 할지 말지 다시 판단하라.


'XXX' 도 마찬가지다

XXX: 여기 큰 위험이 있다. 절대 주의하라.

Xxx: 여기 위험하다 주의하라.

xxx: 여기가 위험한지 다시 판단하라.
*/

코드 주석 작성예

 

개발자가 새롭게 발견한 것

//놀랍게도 이 방식이 기존보다 결과값을 2배 빠르게 보여준다.

// 난 단지 순서만 바꿨을 뿐이다.



개발자의 속마음을 표현한것

//솔직히 이 코드는맘에 안듬

// 팀의 컨벤션만 아니라면 클래스명부터 바꿨을 것이다.



다른 사람에게 보완을 요청하는 것

//전역변수를 잘못 쓰면서부터 이클래스는 엉망이 되었다.

//누가 좀 수정좀 해주삼



할 일이나 주의, 개선 아이디어를 주는 것

// TODO: 동영상이 아닌 동영상 확장자를 확인하는 기능을 넣을것

// XXX: null 이 입력되면 무한 루프 가능성 이?ㅆ음

// Hack: 이 스크립트는 받는 페이지에서 처리하는것이 낫다

// 이 버튼은 한 번만 호출하면 됩니다.



이유를 알려주는것

// 모바일에서 테스트했더니 0.5 이상은 품질 차이가 없었다.

// 로딩 속도는 2배 빨랐다.

image_quality = 0.5



예상 질문과 답

//잘 보면 왜 마지막 대화 ID를 기록하는지 궁금할 것이다.

// 팀 사이트에서 LastTalkId 변수를 검색해서 확인하자.