본문 바로가기

IT

Effective Typescript - 30 - 문서에 타입 정보를 쓰지 않기

* 주석과 변수 이름에 타입에 관련한 정보를 적는 것은 기피해야 한다.

* 함수 시그니처 만으로도 타입에 대한 정보를 모두 파악이 가능한데, 주석의 정보와 함수 시그니처의 정보가 계속 동기화 되지 못할 가능성을 고려해야한다. 

* 타입이 명확하지 않은 경우는 변수명에 단위 정보를 포함하는 것을 고려하는 것이 좋다. (예를 들면, timeMs or temperatureC).