코드 수정시 주의 사항 ver.1

다음 내용은 내가 코드를 작성하면서 경험적으로 얻은 tip들입니다.

이미 대부분 코드 작성하시는 분들은 잘 아실거라고 생각합니다.

물론 제 경험에 기반한 것이므로 다를 수도 있습니다.

 

1) 주석 

= 가끔 예전 코드를 수정하거나 필요할때가 있다.

예전에 작성해놓은 코드에 구현해놓은 일부분이 필요해서 찾아보면 헷갈리고는 한다.

그럴때면 예전에 내가 작성해놓은 주석이 매우 큰 도움이 된다.

마치 '사진'을 보면서 추억을 회상하듯이 주석을 통해 내 코드를 기억해낸다.

팀 프로젝트를 진행할 때 코드의 주석은 매우 큰힘이된다.

 

2) 파일 제목

= 코드를 작성하다보면 backup 파일을 만드는데 잘못하면 헷갈린다.

파일을 찾을때 파일제목을 보고 찾는데 제목에 날짜만 쓰여 있으면 크게 헷갈린다.

그렇다고 매번 열어서 주석을 보고 찾는것도 쉽지 않다.

파일 제목에 간략하게라도 무엇을 했는지 '힌트'라도 써놓으면 큰 도움이 된다.

 

3) 변수

= 변수이름 정하는 거는 프로그래머의 가장 큰 어려움이라고 한다.

처음에는 공감을 못했는데, 논문 구현을 할때 일이 어렵거나 오래걸릴수록 변수가 겹칠확률이 생긴다.

처음에 귀찮아서 a1, a2, aa, 이런식으로 변수 설정하다가 스파게티 코드가 되어갔다.

그렇다고 변수의 의미를 너무 자세히 설명할려고 길게 작성하면 코드를 한눈에 보기 어려웠다.

변수이름은 항상 신중하게 작성해야 한다고 생각한다.

 

4) log 작성

= 정말 오랜된 코드는 이름이랑 주석, 변수를 봐서는 의미를 기억못할때가 있다.

그래서 나는 개인적인 노트 어플에 오늘 어떤코드를 어느 파일위치에서 작성했는지 간략하게 쓴다.

그리고 해당 코딩 작업을 하면서 참고한 홈페이지는 url로 항상 같이 작성한다.

사람은 똑같은 실수를 하기 때문에ㅎㅎ 같이 넣어놓으면 큰 도움이 되었다.

 

 

제 개인적인 경험이므로 참고만 부탁드립니다.

2편, 3편도 기회가 되면 작성해보도록 하겠습니다.

만약 해당 글을 가지고 가시면 reference 부탁드립니다.