해피그래머

타입스크립트 코딩 가이드라인 본문

Typescript

타입스크립트 코딩 가이드라인

해피그래머 happygrammer 2017.06.19 11:00

타입스크립트 코딩 가이드라인을 보기 쉽도록 정리해 보고자 한다.

이름

이름에 대해서 살펴 보고자 한다.

  • 파스칼케이스(PascalCase)를 이용하는데 첫 문자를 대문자로 만드는 방법이다. 예) PascalCase

    • enum 값

      • enum Color { red } (X) enum Color { Red } (O)

    • 네임스페이스 값

      • namespace Foo { }

    • 인터페이스

      • interface Foo { }

    • 클래스

      • class Foo{ bar: number; hello() {} } (O)

      • class Foo { Bar: number; Hello() { } } (X)

  • 카멜케이스(camelCase)는 두번째 단어 이후 부터 단어의 첫글자를 대문자로 만드는 방법이다. 예) camelCase

    • 함수 이름

      • function helloWorld(){ ... } (O)

      • function HelloWorld{ ... } (X)

    • 프로퍼티(property) 이름

      • var fooVar; (O)

    • 지역 변수 이름

  • 인터페이스 이름 앞에 I를 붙이지 않는다. 예) IFoo(X)

  • 비공개 프로퍼티 앞에 _를 붙이지 않는다. 예) _foo(X)

  • 가능한 전체 단어를 사용한다.

문자열

  • 문자열인 경우 쌍 따옴표를 이용한다. 예) "hello world"

  • diagnosticMessage.json을 만들어서 모든 문자열 메시지는 지역화 시켜 사용한다.

일반적인 구성

  • ECMAScript 5 함수를 사용하지 말고 core.ts에 정의된 함수를 사용하라

  • for in을 사용하지 말고 대신 ts.forEach, ts.forEachKey 그리고 ts.forEachValue를 사용하라.

  • 불편하지 않다면 loop대신에 ts.forEach, ts.map 그리고 ts.filter를 사용하라.

스타일

  • 타입 앞에 공백을 넣는다. 예) const foo: string = "hello";

  • 세미콜론, 콜론, 컴마 뒤에는 항상 공백을 둔다. 예) for (var i = 0, n = str.length; i < 10; i++) { }

  • 변수는 단일 선언을 한다. (i.e. use var x = 1; var y = 2; over var x = 1, y = 2;).

  • 앞의 공백(indentation)은 스페이스 4개로 맞춘다.

  • 화살표 함수

    • (x) => x + x (X)

    • x => x + x(O)

    • (x,y) => x + y(O)

    • <T>(x: T, y: T) => x === y(O)


Null과 Undefined

  • null을 반환하지 말고 undefined로 반환할 것 예) return null ;(X), return undefined;(O)

  • null / undefined를 체크할 때는 ==, undefined / !=를 사용하고 === / !==는 사용하지 말것

    • if (error !== null) (X)

    • if (error != undefined) (O)

  • 타입에 undefined를 두지 말고 y?로 처리할 것

    • let foo = {x:123,y:undefined};

내용에 누락이 있거나 보완이 필요한 내용이 있다면 코멘트 부탁드립니다.

'Typescript' 카테고리의 다른 글

타입스크립트 코딩 가이드라인  (0) 2017.06.19
타입스크립트 2.0 베타버전 출시  (0) 2016.07.15
0 Comments
댓글쓰기 폼