728x90

JSDOC 2

소통의 중요성... feat. JSdoc

서두 이번에 입사하면서 회사 코드를 확인했는데 여러모로 쉽지 않았다. 왜 nest가 인기가 많은지 새삼 체감하는게, express가 워낙 자유도가 높다고는 하지만, 변수명 빼고는 모든 부분이 들여다봐야 이해가 가능했다. 이미 전 포스트에서 sql인젝션에 대비하지 않고 쿼리문에 직접 변수를 넣는 것부터 어느정도 나의 포지션에 대해 직감하고 있는 중이다...ㅎㅎ 당장 api를 수정해서 적용해야 하는 일이 있었는데, 소통하면서 개발하는 단계면 상관없는데 테스트하자마자 바로 서버에 적용을 해야하는 상황이라서 에러처리를 확실히 해야하는데 이미 구현되어있던 api들을 보았을 때 에러처리가 명확하지 않은 부분들이 있기도 했고, 설명하긴 너무 길어지고.. db관련 에러를 throw하지 않고 컨트롤러로 옮기는 등.. 방..

개발/프로젝트 2023.10.16

[엘리스트랙 SW 4기 | 2차 프로젝트 복기] 소통왕 프로젝트 / 별도의 docs를 작성하여 jsdoc 주석 적용

발단 리팩토링하면서 코드의 가독성을 위해 간결하게 적거나 네이밍 컨벤션, 아이덴테이션 등 여러 가지를 통일하며 진행하고 있다. 문득 새로운 방법이 떠올랐다. 프레임워크나 라이브러리의 함수에 마우스를 호버해서 정의된 내용을 확인하듯, 마우스를 호버했을 때 req, res에 대한 설명이나 자세한 팁을 알려줄 수 있지 않을까 싶었다. 물론 api명세서를 통해서 확인할 수 있지만, 조금 더 간편하고 빠른 팁을 제공하자는 생각이다. 해결 과정 1. 함수 상단에 jsdoc 주석 달기 그래서 구글링해본 결과, 함수 위에 이런 식으로 jsdoc형식의 주석을 추가할 수 있었다. /** * 회원가입 * @param req.body name: 이름, username: 사용자 ID, password: 패스워드, email: ..

개발/프로젝트 2023.07.02
728x90