20240122 log

주말동안 읽고 보고 느낀 것에 대한 간단 정리.

 

1. 문서화하자!

모든 개발자는 문서 작성을 싫어한다.

 

문서 작성을 좋아하는 개발자가 몇이나 되겠는가? 들었던 것 중에 인상이 남아 정리해본다. 

https://www.youtube.com/watch?v=lBxXKJyAJ28

 

1. 코드 자체의 문서화

코드를 기본적으로 잘 작성하면 문서화 할 필요가 없다. 다만 아무리 잘 짜더라도 문서화가 필요한 경우가 있다. 예를들어 더 나은 효율을 위해 복잡하게 가독성을 포기해야한다던가, 알아야하는 도메인 정보가 있다던가 등등이 있다.

 

기본적으로 코드를 잘 작성해서 문서화 할 필요 없게 만드는게 정석이며 문서화가 필요하다면 본인이 코드를 잘 못짜는 것은 아닌지 의심해보자.

2. 프로세스 문서화 3:25

회사 절차에 대한 문서화하는 경우가 있다. 개발 환경이던지, DB 설치 방법이라든지에 대한 정보가 있을 것이다.

3. 라이브러리, API 문서화 6:45

인터페이스에 대한 문서가 필요하다. 팀간의 공유를 위해

 

-> 문서 작성을 잘하지 못하는 개발자는 코드를 작성할 때도 이상하게 작성할 수가 있다. 예를 들어 언어 능력이 낮다면 모두가 공감할 수 있는 변수명을 작성하는데 어려움이 있을 것이고, 간단하게 정의할 수 있는 메서드 명을 길게 적을 수도 있다.

 

2. 테스트 코드에 대한 간단 정리

 

https://www.youtube.com/watch?v=PqA6zbhBVZc&t=311s

 

 

과거에 한번 봤던 적 있으나 그 땐 이해하지 못했던 부분들을 많이 이해하게 되었다. 하지만 주말동안 테스트 코드에 대한 이해도를 많이 높혀놓으려고 했으나 공부를 하지 않았다. 반성한다 ㅜㅜ..

 

3. 테스트 코드를 잘 작성하는 방법.

https://www.youtube.com/watch?v=VygGrcq0VX0

 

버그에 대한 Repro step을 잘 작성할 수 있어야지만이 테스트 코드를 잘 작성할 수 있다.

 

-> 다시 쉽게 말하면 테스트 과정과 버그를 다시 구현하고, 테스트를 구현하기 위해 필요한 것들을 생각할 수 있어야 객관적으로 바라볼 수 있다는 것이다. 버그가 일어나는 순서와 그 과정을 잘 나열할 수 있다면 개발자들이 이를 고치는데 도움이 될 수 있다.

 

4. 테스트 코드 작성 노하우

https://www.youtube.com/watch?v=XSkz0kO7J3w

 

가장 인상 깊었던 영상.

 

내가 왜 잘못된 코드를 작성했는지에 대한 정리가 도움이 되었다.

 

1. 테스트를 할 때 의존하는 객체에 대해서 검증하지 못하면 Black Box 구역이 만들어지고 이에 따라 파생되는 Black Box 구역이 넓어진다. 이를 해결하기 위해서는 검증이 되지 않은 객체들을 테스트하려는 코드의 로직에서 바깥으로 밀어내야 한다.
2. 테스트 코드 작성은 내가 제대로 된 코드를 작성했는 지에 대한 피드백을 준다. 만약 테스트가 어렵다고 느껴진다면 아마도 코드 자체에 문제가 있는 것일 확률이 높다.