๋ชฉ๋กJS (6)

๐ŸŒฑ → ๐ŸŒณ

JSDoc ๋ž€?

๐Ÿ“Œ JSDoc ๋ž€? ์ผ์ข…์˜ ์ฃผ์„ ๋‹ฌ๊ธฐ ๊ฑฐ์˜ ํ‘œ์ค€ํ™”๊ฐ€ ๋˜์–ด์„œ Vscode, Webstorm ๋“ฑ ์—์„œ๋Š” ๊ธฐ๋ณธ์œผ๋กœ ๊ธฐ๋Šฅ์„ ์ œ๊ณต ํŠน์ • ํ˜•ํƒœ๋กœ ์ฃผ์„์„ ๋‹ฌ๋ฉด ํ•ด๋‹น ์ฃผ์„ ๋‚ด์šฉ์„ ํ†ตํ•ด ํ•จ์ˆ˜์˜ ๊ธฐ๋Šฅ ๋˜๋Š” ๋งค๊ฐœ ๋ณ€์ˆ˜์˜ ํƒ€์ž…๋“ฑ์„ ๋ฏธ๋ฆฌ ์•Œ๋ ค์ค„ ์ˆ˜ ์žˆ์Œ ์ฃผ์„์„ ๋‹ฌ ๋•Œ /** */ ๋กœ ๋‹ฌ๋ฉด ๋จ โœ… JSDoc ๋ถ€๊ฐ€ ๊ธฐ๋Šฅ @todo ๋ฉ”๋ชจ์ฒ˜๋Ÿผ ์‚ฌ์šฉ ๊ฐ€๋Šฅ, ๊ฐœ๋ฐœํ•˜๋‹ค๊ฐ€ ๋ฉˆ์ถœ๋•Œ ๋‹ค์Œ๋ถ€ํ„ฐ ํ•ด์•ผํ•  ๊ฒƒ ์จ๋†“๊ธฐ /** * @todo ๋‚ด์ผ ์ƒˆ๋กœ์šด ๋งค๊ฐœ๋ณ€์ˆ˜ ์ถ”๊ฐ€ ํ•ด์•ผํ•จ due to 10:30 .. */ @deprecated ๋” ์ด์ƒ ํ•ด๋‹น ๊ธฐ๋Šฅ์„ ์“ฐ์ง€ ์•Š์„ ๋•Œ ์ถ”๊ฐ€ -> ํ•จ์ˆ˜ ์“ฐ๋ฉด ๊ฐ€๋กœ์ค„์ด ๊ทธ์–ด์ง @type {ํƒ€์ž… ํ˜•ํƒœ} ๋ณ€์ˆ˜์— ํŠน์ • ํƒ€์ž…์„ ์“ฐ๋ผ๊ณ  ์•Œ๋ ค ์ค„ ๋•Œ ์‚ฌ์šฉ์ด ๊ฐ€๋Šฅ ์š”์ฆ˜์€ typescript๊ฐ€ ์ด ์—ญํ• ์„ ๋Œ€์‹  ํ•ด์ค˜์„œ ์ž˜ ์•ˆ์“ฐ๊ธด ํ•จ โœ… JSDoc..

Client/Javascript 2022. 8. 29. 13:43