TypeScript 코드 문서화를위한 도구 및 가이드?

TypeScript 코드 문서화를위한 도구 및 가이드?

---

TypeScript 소스 코드에 대한 문서를 생성하는 도구가 있습니까? 아니면 NaturalDocs와 같은 일반적인 것을 사용해야합니까? 블록 주석의 권장 스타일 / 독립형 문서 볼륨을위한 주석은 무엇입니까?

내가 사용해야할까요 :

///<foo>bar</foo> MSVS kind of comments?

또는

/** @javadoc style comments */

또는 아마도

/*
  Something like this?
 */

///수입 에 사용 되기 때문에 사용하는 것이 두렵고 , 비슷한 방식으로 도입 될 수있는 다른 미래 기능을 밟고 싶지는 않지만 당신은 결코 알지 못합니다.

아니면 TypeScript에서 문서화 된 JavaScript를 생성 한 다음 JavaScript 도구 모음을 사용할 수 있습니까?

---

조금 늦었을 수도 있지만이 문제를 발견 한 후에도 여전히이 작업을 수행 할 도구가 없음을 발견했습니다. 그래서 TS 컴파일러를 포크하고 코드를 만들었습니다.

v0.9.0.1의 Forked TypeScript 컴파일러 프로젝트는 코드에 넣은 JSDoc에서 위키 문서를 생성하는 "--documentation"옵션을 추가했습니다 (메소드 / 속성 등의 일반 출력에는 필요하지 않음).

https://typescript.codeplex.com/SourceControl/network/forks/EdwardNutting/TypeScriptDocumentationGeneration

.ts.wiki 파일을 생성합니다 (새로운 --wikiRemoveRoot 및 --wikiSourceRoot 매개 변수도 사용하는 경우 CodePlex 등에 직접 업로드하는 데 적합한 콘텐츠-fork-내 첫 번째 커밋 설명 참조). 또는 HTML을 생성하도록 코드를 수정할 수 있습니다 (상대적으로 간단 할 것입니다. 컴파일러 / delcrationEmitter :))

이것이 도움이되기를 바랍니다 (이 질문에 대한 귀하 또는 미래의 독자)

Ed

---

TypeScript * .ts 파일에서 html api 문서 페이지를 생성하는 TypeDoc이라는 도구를 방금 출시했습니다.

문서 생성기는 TypeScript 컴파일러를 실행하고 생성 된 컴파일러 기호에서 유형 정보를 추출합니다. 따라서 댓글에 추가 메타 데이터를 포함 할 필요가 없습니다.

시험 해보고 싶다면 npm을 통해 도구를 설치하고 실행하기 만하면됩니다.

npm install typedoc --global
typedoc --out path/to/documentation/ path/to/typescript/project/

TypeDoc으로 만든 문서가 어떤 모습인지 알고 싶다면 프로젝트의 GitHub 페이지로 이동하세요.

http://typedoc.org/ | https://github.com/TypeStrong/typedoc

---

함수 위에 이런 종류의 주석을 사용할 수 있습니다.

/** 
* Comment goes here
*/

그리고 당신이 당신의 방법을 치면 문서와 함께 나타날 것입니다.

---

TypeScript 언어에 대해 제안 된 문제 중 하나 인 XML 문서 주석을 생성 합니다.

현재 TypeScript 도구는 JSDoc Announcing TypeScript 0.8.2를 지원 합니다.

따라서 주석에 JSDoc 스타일을 사용하고 싶습니다. IntelliSense에 대한 주석 만 필요한 경우 JSDoc을 사용하면 요구 사항이 충족됩니다. API 소비자에게 문서를 제공하기 위해 주석이 필요한 경우 주석과 함께 선언 파일 (* .d.ts)을 사용해야합니다. 웹에서 멋진 문서를 생성하고 싶다면 TypeScript 팀이 XML 문서 주석 생성을 구현할 때 (또는 직접 작성) 기다리는 것이 쉬울 것이라고 생각합니다.

---

JavaScript로 컴파일하고 jsduck ( https://github.com/senchalabs/jsduck )을 사용 하여 JavaScript 파일을 기반으로하는 API 문서를 생성합니다. 기본값 (!)이없는 필드를 제외하고 완벽하게 작동하는 주석을 제거하도록 tsc에 지시하지 않는 한.

module example {

/**
 * My class description
 * @class example.MyClass
 */
export class MyClass {
    /**
     * Description of my property
     * @property {String} myProperty
     */
    myProperty: string = null;

    /**
     * This property will be removed in compiled JavaScript, that's why
     * this documentation will not be visible in jsduck.
     */
    willNotWork: string;

    /**
     * Description of my method
     * @method myFunction
     * @param {String} myParam
     */
    myFunction(myParam: string): void {
    }
}

} // end of module

---

여기에 선언 (.d.ts) 파일에서 HTML 문서를 생성하는 도구를 작성했습니다 . JSDoc 스타일 주석에 대한 기본 지원이 있습니다.

-d -c선언 파일을 생성하고 주석을 보존 하는 옵션을 사용 하여 TypeScript 소스 파일을 컴파일하십시오 . 그런 다음 설치 후 실행할 수 있습니다.

typescript-docs *.d.ts

표준 출력에 HTML 문서를 생성합니다.

출력을 파일에 저장하려면 다음을 사용하십시오.

typescript-docs *.d.ts --output=path/to/output.html

참조 URL : https://stackoverflow.com/questions/16263480/tools-and-guide-for-documenting-typescript-code