Skip to content

Coding Convention

ukssss edited this page Mar 10, 2023 · 1 revision

Lint

  • ์„ธ๋ฏธ์ฝœ๋ก  ํ•„์ˆ˜ ์‚ฌ์šฉ
  • function ์œผ๋กœ ํ•จ์ˆ˜ ์ž‘์„ฑ, ํ•„์š”ํ•  ๊ฒฝ์šฐ ํ™”์‚ดํ‘œ ํ•จ์ˆ˜ ์‚ฌ์šฉ
  • ์ƒ๋Œ€ ๊ฒฝ๋กœ๋กœ import, export ๋ฅผ ์‚ฌ์šฉ
  • export ํ•  ํ•จ์ˆ˜๋Š” function ์„ ์‚ฌ์šฉ
  • var ์ ˆ๋Œ€ ๊ธˆ์ง€ !!, const, let ์‚ฌ์šฉ
  • ์นด๋ฉœ์ผ€์ด์Šค(camelCase) ์‚ฌ์šฉ

Tap Depth

  • ๊ธฐ๋ณธ Tab Depth 2, ์ตœ๋Œ€ Tap Depth 4
  • depth ๊ฐ€ 4 ์ด์ƒ์œผ๋กœ ๊นŠ์–ด์ง€๋ฉด ํ•จ์ˆ˜๋ฅผ ํ†ตํ•ด ๋‚˜๋ˆŒ ์ˆ˜ ์žˆ๋„๋ก ์„ค๊ณ„ํ•  ๊ฒƒ !

Naming

  • ์ด๋ฆ„์„ ํ†ตํ•ด ์“ฐ์ž„์ƒˆ๋ฅผ ์•Œ ์ˆ˜ ์žˆ๋„๋ก ์ž‘๋ช…ํ•  ๊ฒƒ (20์ž ๋ฏธ๋งŒ, ์ง๊ด€์ )
  • ์ด๋ฆ„์˜ ๋งจ ์•ž์ด๋‚˜ ๋งจ ๋’ค์— ์–ธ๋”๋ฐ”(_)๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š์„ ๊ฒƒ
    • ๋ณ€์ˆ˜, ํ•จ์ˆ˜, ์ธ์Šคํ„ด์Šค ๐Ÿ‘‰๐Ÿป camelCase (์นด๋ฉœ ์ผ€์ด์Šค)
    • ํด๋ž˜์Šค, ์ƒ์„ฑ์ž๋ช… ๐Ÿ‘‰๐Ÿป PascalCase (ํŒŒ์Šค์นผ ์ผ€์ด์Šค)
    • ์ƒ์ˆ˜ ๐Ÿ‘‰๐Ÿป SCREAM_SNAKE_CASE (์Šคํฌ๋ฆผ ์Šค๋„ค์ดํฌ ์ผ€์ด์Šค) ์ฐธ๊ณ ์ž๋ฃŒ
    • Page, Component ๐Ÿ‘‰๐Ÿป PascalCase (ํŒŒ์Šค์นผ ์ผ€์ด์Šค)
    • img ๐Ÿ‘‰๐Ÿป kebab-case (์ผ€๋ฐฅ ์ผ€์ด์Šค)
  • ํ•จ์ˆ˜ ์ด๋ฆ„์€ ๋™์‚ฌ + ๋ช…์‚ฌ ๊ตฌ์กฐ๋กœ ๋„ค์ด๋ฐํ•  ๊ฒƒ.

Comment

**// ๊ธฐ๋ณธ ์ฃผ์„**

**// ?** ์˜๊ฒฌ.
 โ†’ ์˜๊ฒฌ์„ ๊ตฌํ•ด์•ผํ•˜๊ฑฐ๋‚˜, ํ”ผ๋“œ๋ฐฑ์„ ์š”์ฒญํ•  ๊ฒฝ์šฐ ์‚ฌ์šฉ.

**// !** ์ฃผ์˜
โ†’ ์‹ ๊ฒฝ ์“ธ ๋ถ€๋ถ„์ด๋‚˜ ์ค‘์š”ํ•œ ์ด์•ผ๊ธฐ๊ฐ€ ์žˆ์„ ๋•Œ ์‚ฌ์šฉํ•ด์ฃผ์„ธ์š”.

์ฃผ์„์„ ์ตœ๋Œ€ํ•œ ์•ˆ์“ฐ๊ฒŒ๋” ์ฝ”๋“œ๋ฅผ ์ž‘์„ฑํ•  ๊ฒƒ ! ! !

ETC

  • console.log() ๋ฅผ ์ง€์šฐ๊ณ  Pull Request ์š”์ฒญํ•˜๊ธฐ
  • ์‚ผํ•ญ ์—ฐ์‚ฐ์ž ์‚ฌ์šฉ์„ ์ง€์–‘ํ•ฉ๋‹ˆ๋‹ค.
  • ๋ฐ˜๋ณต๋˜๋Š” ์ฝ”๋“œ๋ฅผ ์ค„์—ฌ ํšจ์œจ์ ์ธ ์ฝ”๋“œ๋กœ ์„ค๊ณ„ํ•ด์ฃผ์„ธ์š”.
  • 1 ํ•จ์ˆ˜, 1 ์ž‘์—…, ์ฆ‰ ํ•˜๋‚˜์˜ ํ•จ์ˆ˜๋Š” ํ•˜๋‚˜์˜ ์ผ์„ ํ•˜๋„๋ก ์„ค๊ณ„ํ•ด์ฃผ์„ธ์š”.
Clone this wiki locally