[TIL-19] 보안 관련 자료 팀에 배포하기, 코드 문서화, 코드리뷰를 해야하는가

[그림1]. 오늘도 감사한 공부 시작 ~

 

목차

0. 오늘의 학습 시간
1. 오늘 배운 것
2. 감사한 일

 

0. 오늘의 학습 시간

[스파르타 내일 배움 교육]

09:00 ~ 24:00: 약 15시간

 

1. 오늘 배운 것

1. 보안 관련 자료 팀에 배표

 

[그림2]. 자료 예시

2. 코드 문서화

[그림3]. 코드 문서화

 

3. jinja2의 유효 범위
:개발 관련 코드를 보다보니, jinja같은 템플릿 엔진이 동작 범위가 어디까지인지 헷갈릴 때가 있다. 코드에서 보면 유저 정보가 들어있는 객체를 같이 리턴해준다. 물론 템플릿 엔진에서 돌아간 뒤 페이지가 리턴되는 부분이라 크게 문제 없을 거 같지만 그래도 위험해보인다. profile 관련 db를 새로 생성해야 할 거 같다.

[그림4]. 헷갈렸던 코드

 

4. 코드리뷰를 해야하는가

사실 여태까지 진행한 해커톤은 경력이 있는 개발자들이나 아예 다른 분야의 사람들과 했었다. 해커톤 특성상 좋은 코드보다 기능 구현에 중점이 맞춰져 있었기 때문에 코드리뷰를 할 경우가 거의 없었는데, 그러다 보니 지나친 환상이 있었던 거 같다. 이번 프로젝트를 진행하면서 코드 리뷰에 대한 고민을 해봤는데 프로젝트에 여유가 있었음에도 코드리뷰를 하는게 쉽지 않았다. 코드 리뷰를 하는 목적이 내가 성장하는데 맞춰진 것이 아니라 '좋은 회사에 취업하면 다들 한다던데?'라는 맹목적인 믿음. 선망등에 매몰된게 아닐까라는 생각이 들었다. 프로젝트가 안정화된 상태에서는 의미있는 일이지만 개발 단계에서는 불필요한 병목 현상을 발생시킬 수 있으니 지금 상황을 잘 고려해서 적용해야 한다는 결론을 얻었다.

[그림5]. 코드 리뷰, 고민해볼 점

 

2. 감사한 일

 

오늘 팀원들에게 관련 자료를 문서화해서 줬는데 왠지 기분이 좋았다. 내가 열심히 한 내용을 잘 전달했다는게 왠지 모르게 뿌듯했다.

 

 

 

오늘 하루도 공부할 수 있어 크게 감사합니다

2022-05-13 개발자 최찬혁