자바스크립트 주석 달기 (업데이트)

250x250

Notice

Recent Posts

Recent Comments

Tags more

Archives

관리 메뉴

체인의정석

개발/backend

체인의정석 2022. 11. 7. 10:53

728x90

이번에 이직을 하게 되면서 여러 팀원들과 함께 개발 내용을 공유할 상황이 되었다.

내가 담당한 부분은 많은 팀원들이 공통적으로 사용할 부분이기 때문에 주석을 한번 제대로 달아봐야지 하는 생각이 들었다.

WordPress Developer Resources | Official WordPress Developer Resources

Official WordPress developer resources including a code reference, handbooks (for APIs, plugin and theme development, block editor), and more.

developer.wordpress.org

위의 글이 좀 잘 나와있는것 같앗다.

Best Practices For Using Comments In JavaScript

How to Use Comments Efficiently in JavaScript

blog.bitsrc.io

일단 이번에 쓴 내용은

1. @description : 내가 작성한 클래스나 함수에 대한 설명

2. // 정의한 클래스 내부의 요소들에 대한 주석

이렇게 2개이다.

개발성 향상을 위한 JavaScript의 주석 – GIS Developer

JavaScript는 type이 불명확하므로 문서화를 통해 그 상세정보를 남겨야 합니다. 그러나 소스코드와 분리된 문서는 사실상 그 활용가치가 매우 떨어집니다. 소스코드와 일원화된 방식으로 문서화가

www.gisdeveloper.co.kr

자바스크립트에서 주석을 달때

@param{""|""|}

이런식으로 하면 파라미터에 대한 타입을 잘 서명할 수 있다.

728x90

Mocha로 테스트 하기 팁 모음 (0)	2022.11.11
javascript Map vs filter 차이 (0)	2022.11.07
Class에서 static 사용하기 (2)	2022.11.02
Node.js에서 자주 쓰이는 Javascript 문법 정리 1편 (0)	2022.10.28
Mac Backend 기본세팅 - 기존 프로젝트에 온보딩 하기 (0)	2022.10.28

'개발/backend' Related Articles

Comments