[Javascript Pattern] 자바스크립트 패턴 개론 #2

이전시간에 이어서 패턴 개론에 대해서 이어가도록 하겠다.

 

주석

- 모든 변수, 모든 행에 주석을 다는 게 아닌 특이하고 흥미로운 알고르즘이나 기법을 사용한 사용한 경우에 주석을 단다.
  주석은 코드를 읽을 미래의 독자에게 주는 힌트

 

API 문서 작성

아래는 JS Doc를 자동으로 생성해 주는 무료 툴이다. 요구하는 형식에 맞게 주석을 달면 툴에서 자동으로 해당 API 문서를 만들어 낸다.
- JSDoc : http://code.google.com/p/jsdoc-toolkit

- YUIDoc : http://yuilibrary.com/projects/yuidoc

독자를 위한 문서 작성

- API 문서를 작성하라는 것은 초안일 뿐인 첫 번째 코딩에 대해서 문석 작성시 한번 더 살펴 독자 입장에서 살펴 보라는 것이다.

코드 또는 API 문서를 작성할 때 다른 누군가가 읽을 것이라고 생각하라는 것이다. 이 사실 자체만으로도 눈 앞의 문제를 해결하는 좀더 나은 방법을 생각해 보게 된다.

 

동료 리뷰

- 애자일에서 코드 품질을 높이는데 사용하는 방안이다.

자신이 작성한 코드를 옆에 있는 동료에게 검토를 부탁이나 설명을 해주는 것만으로도 가능하다. 이런 방법으로 서로의 경험과 개개인의 접근방식을 배우게 된다는 점에서도 장점을 찾을 수 있다.

 

출시 단계(개발완료 단계)의 압축

- 압축이란 자바스크립트 코드에서 공백, 주석 및 기타 중요하지 않은 부분들을 삭제함으로써 서버에서 브라우저로 전송되는 파일 크기를 감소시키는 공정이다.

압축에 관련된 툴로는 YUI컴프레서, 구글의 클로저 컴파일러, Microsoft Ajax Minifier 가 있다. – 대략 절반 정도의 압축을 할 수 있다.
      - http://yui.github.com/yuicompressor/, http://refresh-sf.com/yui/ online에서 압축 시켜 줌.
      - http://closure-compiler.appspot.com/home online 지원, https://developers.google.com/closure/compiler/?hl=ko
      - http://www.asp.net/ajaxlibrary/AjaxMinDocumentation.ashx, http://aspnet.codeplex.com/releases/view/40584 Download

- 압축 시 지역 변수는 임의의 변수로 치환되어 압축 한다.

 

JSLint 실행

- JSLint에서 제공되는 가이드 라인에서 위배되는 사항을 개발자가 알 수 있도록 알려주는 툴이다.

일반적인 개발 사항에서 좀더 가시적이고 오류가 없도록 도와주는 역할을 하는 도구다.

- Visual Studio JSLint를 컴파일 단계에서 점검해 볼 수 있도록 확장 기능을 제공하기도 한다.