• 검색 결과가 없습니다.

jsDoc 샘플 실행하기

 

윈도우에 Perl 설치가 끝나면 C:₩Perl₩bin 디렉토리를 패스에 걸어주자. 설치된 펄을 uninstall 하는 것 은 아주 간단하다. 설치한 C:₩Perl 디렉토리를 통째로 삭제하면 된다.

   

/**

 * @fileoverview This file is an example of how JSDoc can be used to document  * JavaScript.

 *

 * @author Ryan Asleson  * @version 1.0

 */

/**

 * Construct a new Person class.

 * @class This class represents an instance of a Person.

 * @constructor

 * @param {String} name The name of the Person.

 * @return A new instance of a Person.

*/

function Person(name) {     /**

     * The Person's name      * @type String     */

    this.name = name;

    /**

     * Return the Person's name. This function is assigned in the class      * constructor rather than using the prototype keyword.

     * @returns The Person's name      * @type String

    */

    this.getName = function() {         return name;

    } }

/**

 * Construct a new Employee class.

 * @extends Person

 * @class This class represents an instance of an Employee.

 * @constructor

 * @return A new instance of a Person.

*/

function Employee(name, title, salary) {     this.name = name;

    /**

     * The Employee's title      * @type String

    */

    this.title = title;

    /**

     * The Employee's salary      * @type int

    */

    this.salary = salary;

}

/* Employee extends Person */

Employee.prototype = new Person();

/**

 * An example of function assignment using the prototype keyword.

 * This method returns a String representation of the Employee's data.

 * @returns The Employee's name, title, and salary  * @type String

*/

Employee.prototype.getDescription = function() {     return this.name + " - "

        + this.title + " - "

        + "$" + this.salary;

}  

<jsDocExample.js 의 전체 소스 코드>

 

위 jsDocExample.js 파일을 jsDoc 을 사용하여 다큐먼트를 생성한 결과는 아래와 같다.

 

AJAX 강의 5-2장 - FireFox 확장기능을 이용한 HTML 코드검사

1999년 말의 Microsoft vs Netscape 간의 전세계 웹 브라우저 시장 잠식을 위한 전쟁은 각 브라우저의 고유한 특성에 맞는 html 코드를 남발하는 결과를 초래하게 되었고(전쟁으로 인한 피해는 심각했다. 그 피 해의 영향권 아래에서 우리는 여전히 자유롭지 못하다.), 웹 페이지들은 표준을 지키지 않는 코드들로 넘쳐 났다. 결국 IE 가 승리하였고 국내 웹 브라우저 시장은 승전국인 MS 의 IE가 완전히 석권했다. 당연한 결 과이지만 HTML 코드는 IE 에 종속될 수 밖에 없었고, 보안이라는 명목으로 ActiveXObject가 광법위하게 펴져나갔다.

 

현존하는 대부분의 브라우저들은 W3C 의 표준을 잘 지키려고 노력하고 있다. 그래야만 웹을 이용하는 사 용자들이 브라우저에 상관없이 믿고 사용할 수 있게 된다. 타인에 대한 배려 차원이랄까? 하지만 대한민국 에서는 아직까지 잘 지켜지지 않고 있다. 가장 큰 문제는 은행쪽이다. IE 를 빼고는 다른 브라우저로는 접 근할 수 조차 없게 만들어 놨다. 인터넷뱅킹을 하려면 반드시 IE 를 사용하라는 얘기다. 인터넷 뱅킹을 개 발할때에도 IE 및 MS 윈도우의 버젼을 고려해 개발하고 테스트할 뿐, 나머지는 전혀 고려대상조차 아니다.

소수 사용자들에 대한 무시인가? 나는 소수에 대한 폭력이라고 생각한다. 사실 기타 모질라류의 웹 브라우 저에 대한 이윤이 창출될 만한 시장조건(사용자층의 기하급수적인 폭발)이 조성되지 않는 한 이러한 현상 은 앞으로도 계속 벌어질 것이다. 이러한 왜곡된 시장에 길들여진 개발자는 결국 반쪽짜리 개발자로 전락 하고 말 것이다.

 

비단 은행뿐만 아니라 포털싸이트도 마찬가지인데...네이버 블로그 같은 경우도 FireFox 를 사용해서는 100% 기능을 활용할 수 없다. FireFox로 블로깅을 작성하다가 최근 덧글을 볼 수도 입력할 수도 없어서 지금은 IE 를 통해서 글을 쓰고 있다.

 

프로그래밍 언어에는 보통 컴파일러라는 것이 있는데, 사람이 읽을 수 있는 코드를 컴퓨터가 쉽게 인식할 수 있는 기계어로 변환해 주는 프로그램이다. 브라우저는 이와 비슷한 역할을 수행한다. 사람이 읽은 수 있 는 HTML 혹은 XHTML 을 번역해서 화면에 보여주는 것이다.

 

브라우저간의 1차 세계 대전이 종료가 된 후에서야 브라우저 메이커들은 W3C 평화협정을 지키기 시작하 였다. 모든 브라우저들은 HTML 의 doctype 에 따라서 두가지 모드(strict mode, quirks mode)로 작동한 다. strict 와 quirk 를 우리말로 바꾸자니 어색한 것 같아 있는 표현 그래도 사용하겠다. 웹 페이지가 HTML 4.1 혹은 XHTML 1.0 등 확실한 W3C 표준 권고안을 준수했다면, 대부분의 웹 브라우저는 stric 모드로 작동한다. 하지만 웹 페이지에서 유효하지 않은 doctype 이나 충돌이 발생했다면 quirk 모드로 작 동한다.

 

개발자라면 확실하게 W3C의 표준을 준수하여 모든 브라우저의 사용자가 사옹할 수 있도록 해야 한다. 그 래야만 브라우저는 HTML 코드로 부터 DOM 객체의 특성을 정확하게 뽑아서 사용할 수 있는 것이다. 표 준을 지키지 않는다면 그만큼 DOM 객체를 다루는 코드가 각각의 브라우저마다 차이가 생기게 되고 이것 은 결국 개발자들의 고민꺼리만 늘어나게 되고 소수 웹 브라우저 사용자들은 소외 되는 결과를 초래한다.

 

브라우저에는 엄격한 문법을 체크하는 컴파일러가 없다. 그렇다면 어떻게 W3C 표준을 준수했는지 알수 있 을까? FireFox 브라우저가 해답을 제시할 것이다.

 

HTML Validator 는 W3C 가 개발한 Tidy 라는 툴에 기반한 프로그램으로, 웹 페이지가 W3C 의 표준을 준수하고 있는지 확인하여 그 결과를 보여준다. Tidy 는 HTML 에러를 3가지로 구분한다.

Errors : Tidy를 이용해서 고칠 수 없고 이해할 수 없는 문제 Warnings : Tidy 를 이용해서 자동으로 수정할 수 있는 에러

Accessiblity warnings : W3C Web Accessibility Initiative(WAI) 가 정의하고 있는 3단계 우선순위 HTML 에러

 

관련 문서