React - JSDoc template ๐Ÿ‘

๊ณ ์€์ •ยท2021๋…„ 6์›” 18์ผ
1

๊ฐœ๋ฐœํฌ์ŠคํŒ…

๋ชฉ๋ก ๋ณด๊ธฐ
9/20
post-thumbnail

์ง€๋‚œ ํฌ์ŠคํŒ…์—์„œ React์— JSDoc๋ฅผ ์‚ฌ์šฉํ•ด์„œ Doxygen์„ ์ž‘์„ฑํ–ˆ์Šต๋‹ˆ๋‹ค.
์ด ํฌ์ŠคํŒ…์„ ์ฝ๊ธฐ ์ „์— ์ง€๋‚œ ํฌ์ŠคํŒ…์„ ๋จผ์ € ์ฝ์–ด์ฃผ์„ธ์š”!
(์ด ๊ธ€์€ ๋ˆ„๊ตฌ๋‚˜ ๋ณผ ์ˆ˜ ์žˆ๋Š” ๋ธ”๋กœ๊ทธ์—์„œ ๋งŽ์€ ๋„์›€์„ ๋ฐ›์•„ ์ž‘์„ฑํ–ˆ์Šต๋‹ˆ๋‹ค.)

JSDoc ํ…œํ”Œ๋ฆฟ

Google์— 'npm jsdoc template'๋‚˜ 'jsdoc template'๋“ฑ์„ ์ž…๋ ฅํ•˜๋ฉด ๋‹ค์–‘ํ•œ ํ…œํ”Œ๋ฆฟ๋“ค์„ ๋ณผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
๊ทธ ์ค‘์—์„œ ์ œ๊ฐ€ ์ ์šฉํ•  ํ…œํ”Œ๋ฆฟ์€ Minami์ž…๋‹ˆ๋‹ค.

์ ์šฉํ•˜๊ธฐ

1. npm์„ ์ด์šฉํ•ด์„œ ํ…œํ”Œ๋ฆฟ์„ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค.

$ npm install --save-dev minami

2. package.json ํŒŒ์ผ์˜ ํ•˜๋‹จ์—์„œ ๋ชจ๋“ˆ์ด ์„ค์น˜๋œ ๊ฒƒ์„ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค.

3. json ์„ค์ •ํŒŒ์ผ์„ ๋งŒ๋“ค์–ด์ค๋‹ˆ๋‹ค.

index.js์™€ ๊ฐ™์€ ๊ฒฝ๋กœ์— ์„ค์ •ํŒŒ์ผ์„ ๋งŒ๋“ค๊ฒ ์Šต๋‹ˆ๋‹ค. ์„ค์ •ํŒŒ์ผ์˜ ์ด๋ฆ„์€ jsdoc.config.json๋กœ ์ž‘์„ฑํ•˜๊ฒ ์Šต๋‹ˆ๋‹ค.

{
    "source": {
        "include": ["./src"] // ์ด ๊ฒฝ๋กœ ์ดํ•˜ js, jsx, jsdoc์„ ๋Œ€์ƒ
    },
    "opts": {
        "encoding": "utf8", // Docs์—์„œ ํ•œ๊ธ€์„ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋„๋ก ์„ค์ •
        "template": "node_modules/minami" //minami ํ…œํ”Œ๋ฆฟ ์ ์šฉ
    }
}

4. ํ…œํ”Œ๋ฆฟ์„ ์ ์šฉํ•ฉ๋‹ˆ๋‹ค.

$ ./node_modules/.bin/jsdoc '๋‚˜์˜ JavaScriptFile.js'
$ ./node_modules/.bin/jsdoc -c jsdoc.config.json

5. outํด๋”์—์„œ html์„ ์—ด์–ด์„œ ์ƒ์„ฑ๋œ ๋ฌธ์„œ๋ฅผ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค.

profile
๊ฐœ๋ฐœ์ด ํ•˜๊ณ ์‹ถ์–ด์š”

0๊ฐœ์˜ ๋Œ“๊ธ€