우주개발자 블로그

documentation (3)

JSDoc에서 템플릿을 사용해 보도록 합시다

프로그래밍 언어/웹 프론트엔드 우주개발자(SpaceDev) 2020. 1. 21. 09:19

📌 연관 글 Javascript Documentation 라이브러리 JSDoc를 사용해 봅시다 JSDoc을 설정 파일로 빼서 사용해보도록 합시다 JSDoc에서 템플릿을 사용해 보도록 합시다 Webpack과 JSDoc을 연동하여 자동화를 시켜봅시다 우리는 기본적인 JSDoc 설정을 끝내고 JSDoc을 이용하여 Documentation까지 만들었습니다. 이렇듯 쉽게 Documentation을 만들수 있고 웹 기반으로 볼 수 있다는 장점은 저희에게 큰 메리트를 줍니다. 하지만 JSDoc이 자동으로 Documentation을 Styling을 해줘서 딱히 특색이 있어 보이진 않습니다. 이러한 사용자의 Needs를 JSDoc 또한 알고 있었을까요? JSDoc에서 템플릿을 지원하고 있습니다. 같이 한번 적용해 보도록..

JSDoc을 설정 파일로 빼서 사용해보도록 합시다

프로그래밍 언어/웹 프론트엔드 우주개발자(SpaceDev) 2020. 1. 16. 10:58

📌 연관 글 Javascript Documentation 라이브러리 JSDoc를 사용해 봅시다 JSDoc을 설정 파일로 빼서 사용해보도록 합시다 JSDoc에서 템플릿을 사용해 보도록 합시다 Webpack과 JSDoc을 연동하여 자동화를 시켜봅시다 자 우리는 JSDoc 설치를 완료하였고 직접 Documentation을 만들기까지 하였습니다. 어떤가요 참 쉽지 않나요? 하지만 각각 필요한 옵션들을 커맨드라인에 입력 후 Documentation을 만드는 일은 참 번거로운 일입니다. 그렇기 때문에 이 JSDoc은 설정파일로 만들어서 사용할 수 있도록 기능을 추가해 놨습니다. 그럼 한번 알아보도록 하겠습니다. JSDoc 설정 파일 만들기 자 저희는 이전 포스트에서 아래 사진과 같은 구조를 만들었습니다. (만약 이..

Javascript Documentation 라이브러리 JSDoc를 사용해 봅시다

프로그래밍 언어/웹 프론트엔드 우주개발자(SpaceDev) 2020. 1. 15. 13:06

📌 연관 글 Javascript Documentation 라이브러리 JSDoc를 사용해 봅시다 JSDoc을 설정 파일로 빼서 사용해보도록 합시다 JSDoc에서 템플릿을 사용해 보도록 합시다 Webpack과 JSDoc을 연동하여 자동화를 시켜봅시다 여러분들은 Javascript에서 Documentation을 어떻게 관리하고 계시나요? 가장 좋은 방법은 소스코드만 봐도 저절로 읽히는 코드가 가장 좋은 코드이지만, 그렇지 못한 경우이거나 간단한 개발 같은 경우는 주석으로 어떠한 역할을 하는 코드인지 써놓습니다. 하지만 이러한 주석들은 직접 찾아야 하는 번거로움도 있으며, 코드가 인수인계 시 한눈에 확 들어오지 않는 경우도 많이 있습니다. 이러한 문제를 해결하기 위한 라이브러리!! 오늘은 JSDoc에 대해서 알..

Copyright © 우주개발자 블로그 All Rights Reserved

티스토리툴바