코드 서식, 코드 분리, 추상화

2398 단어 CSCS

1. 코드 서식

  • 코드를 작성하는 방식을 의미함.
  • 개발자들마다 저마다의 코드 서식/코드 스타일이 있지만, 일반적인 관점에서 가독성이 좋은 간결한 코드 서식/스타일을 함양하는 것이 중요하다.

코드 서식을 지원하는 도구, Prettier

  • 프리티어는 다양한 언어들에 대해서 자동적으로 코드 서식을 정렬해주는 라이브러리/플러그인이다.

  • 프리티어는 node.js 기준 npm을 이용해서 라이브러리로서 설치할 수도 있고, VS Code와 같은 소스코드편집기에서 플러그인으로도 활용할 수 있다.
    팔레트에서 format document를 Prettier로 설정하면 활용할 수 있다.

  • 프리티어의 규칙은 사용자가 직접 설정할 수 있다. node.js의 라이브러리로 사용하는 Prettier에서는 .preetierrc.js 파일에서 다음 예시와 같이 설정할 수 있다.

module.exports = {
  trailingComma: 'es5', : 코드 서식 언어의 버전
  tabWidth: 2, : tab키의 길이
  semi: true, : 세미콜론 여부
  singleQuote: true,
  arrowParens: 'always',
};

2. 코드 분리

코드를 분리해서 관리하는 목적은 다음과 같다.

  • 가독성 향상
  • 쉬운 관리(유지/보수)

코드를 분리하는 기준은 일반적으로 다음과 같다.

  • 추상화
  • 기능의 역할

추상화란?

  • 특정 기능을 수행하는 로직을 새로운 함수로 분리해서 정의하는 작업.
    (추상화 작업에는 기능의 역할에 대한 고민도 당연히 포함된다.)
  • 추상화는 프로그래밍 언어를 모르는 사람이 보더라도, 그 작업이 어떤 작업인지 알 수 있게끔 해야한다.
  • 추상화 시, 함수의 이름과 함수를 넣어둘 파일의 이름이 매우 중요한 요소로 작용한다
  • 코드의 가독성을 위해 권고된다.
  • 추상화한 로직들은 보통 역할에 맞게 하나의 파일에 묶어서 관리하고, 해당 로직이 필요한 경우에만 함수를 호출해서 사용한다.

기능의 역할에 코드 분리

  • 예를 들면, socket 관련 코드는 socket.js라는 파일에 묶어서 코드를 분리하는 것이 기능의 역할에 따른 코드 분리다.
  • 기능의 역할에 따른 코드 분리를 할 때는, 서버를 실행시키는 코드는 따로 server.js 라는 파일을 생성해서, 분리한 파일들을 server.js에 참조를 시킨 뒤, 그 파일을 기준으로 서버를 실행한다.

좋은 웹페이지 즐겨찾기