Closed h-takeyeah closed 3 years ago
何が変わったのか
TSDocはまだTSのドキュメンテーションの記法のスタンダードと定められてはいませんが,ほぼスタンダードなのでこれに従いました.このPRで書いたTSの書き方でいいかどうかチェックしてもらって書き方の合意を取れれば取りたいです.ただ書き方の議論で時間を消費するのは本意ではないので,長引きそうだったらドキュメンテーション部分は外してコミットし直すかもしれません.
「書き方」: 例えば/** */と1行で書くのを許すか否か,@paramsは最後に書くか最初に書くか,summary(最初の@のない部分)の後は1行開けるか,など.
/** */
@params
@
レビューお願いします.
Redpenのエラーは #66 によるリグレッションなので無視して大丈夫です
何が変わったのか
TSDocはまだTSのドキュメンテーションの記法のスタンダードと定められてはいませんが,ほぼスタンダードなのでこれに従いました.このPRで書いたTSの書き方でいいかどうかチェックしてもらって書き方の合意を取れれば取りたいです.ただ書き方の議論で時間を消費するのは本意ではないので,長引きそうだったらドキュメンテーション部分は外してコミットし直すかもしれません.
「書き方」: 例えば
/** */
と1行で書くのを許すか否か,@params
は最後に書くか最初に書くか,summary(最初の@
のない部分)の後は1行開けるか,など.レビューお願いします.