コメント書く

• Reporter: tsugehara
• Owner: tsugehara
• Type: Feature Requests
• Status: Closed
• Component: (None)
• MileStone: (None)
• Priority: 3
• Severity: 5 - Medium
• Resolution: None
• File: None

Details Reply

0.8.2からjsdocがサポートされたので、APIリファレンス代わりにjsdoc形式のコメントを書くと親切かも。

Ticket History (3/6 Histories)

2013-07-20 15:18 Updated by: tsugehara

• New Ticket "コメント書く" created

2013-07-20 15:22 Updated by: tsugehara

Comment Reply

ちょっとやってみたのだが、まだサポートが不完全な印象。enumにコメントをつける方法などが不明。

また、TypeScript本体はこの、忌まわしいスタイルを一部に使ってる。

/// <summary>
/// Convert a symbol to an array of string parts, each of which has a kind. May be tailored
/// to a specific location in the source code. Useful for colorizing the display string.
/// </summary>
/// <param name="symbol">Symbol to be displayed.</param>
/// <param name="location">A location in the source code (context).</param>
/// <param name="semanticModel">Binding information (for determining names appropriate to
/// the context).</param>
/// <param name="format">Formatting rules - null implies
/// Format.MinimallyQualifiedFormat.</param>
/// <returns>A read-only array of string parts.</returns>
export function toMinimalDisplayParts(symbol: ISymbol,

問題はTypeScript本体でjsdocコメントを一切使っていない事で、完成度が高くなるのは少し先のような気もする。

1.0リリース時とか、もうちょっと待ってからのがいいかも。

2013-07-20 15:36 Updated by: tsugehara

Comment Reply

もう一点、定義ファイルにコメントを出力するためにはtsc --commentsオプションを使えばいいのだが、これを使うとjsファイルにもコメントが残ってしまう。

つまりjsファイルにこういうゴミが混ざる。

 ///<reference path="all.ts"/>
 var jg;
 (function (jg) {
     (function (Angle) {
     })(jg.Angle || (jg.Angle = {}));
 })());
 ///<reference path="all.ts"/>
 var jg;
 (function (jg) {
     var Rectangle = (function () {

2013-07-20 15:37 Updated by: tsugehara

Comment Reply

もうちょっとtypescript本体でコメントサポートが充実するまで、様子見た方がいい気がする。

2013-07-20 15:38 Updated by: tsugehara

• Priority Update from 5 - Medium to 3

2013-07-31 17:35 Updated by: tsugehara

• Status Update from Open to Closed
• Ticket Close date is changed to 2013-07-31 17:35

Comment Reply

とりあえず、typescript本体のコメントサポートが微妙だったので、定義ファイルをコメントあり、jsファイルをコメント無しとするため特殊なバッチを書いた。

またその上でjsdoc形式のコメントを書いた。

r128までで最低限対応完了。後は随時対応する。