2017-12-30 18 views
1

私はそれが簡単な質問でなければならないことを知っています。しかし、私はこれを取り巻くハード・グーグルを試みたが、一つの適切な結果を見つけることができなかった。私は、私の下で働く多数の人々との大きなチームを管理しています。私は開発者によって書かれたすべての関数がその前にコメントを持っていることを確認したい。私のtslintファイルにルールを追加するのは理にかなっています。デベロッパーに機能のコメントを追加さ​​せる

機能の開始前にコメントを追加するにはどうすればよいですか?

/** 
* This function returns a string hello 
* @author Sahil Purav 
*/ 
myfunction(): string { 
    return 'hello'; 
} 
+2

がhttpsですでに開いて発行されたコーディング標準 –

+0

と一緒にプロセスにコードレビューを追加する - これをチェック詳細については

"completed-docs": [ true, { "enums": true, "functions": { "visibilities": ["exported"] }, "methods": { "location": "instance", "privacies": ["public", "protected"] } } ] 

は、私は私の要件を十分次のルールを使用しました/github.com/palantir/tslint/issues/623 –

+0

それはあります...しかし、私たちは自動化された世界で働いています。 tslintルールを持つことは良いことではありません。そのため、コードレビューの前に、レビュー担当者が欠落している標準ではなく開発者によって書かれたロジックにもっと集中するように、関数に関するコメントがあります。 –

答えて

0

私はこの上でいくつかのより多くの研究を行なったし、コメントや良いことを強制するtslint内のルールがあり、それは高度に設定可能であることがわかりました。 /:https://palantir.github.io/tslint/rules/completed-docs/

関連する問題