su-its / ams-backend

:briefcase: (This repository is no longer maintained) The backend server of our Access-management-system.
MIT License
0 stars 0 forks source link

コメントの書き方が統一されていない(TSDocへの移行) #27

Closed h-takeyeah closed 2 years ago

h-takeyeah commented 3 years ago

コメントの書き方が統一されていなかったり,そもそもなかったりする関数もちらほら見受けられるので書けるところはぼちぼちJSDocで書き直していきましょう.【追記】TSDocにしましょう.型の宣言が要らないのでJSDocよりちょっと楽できます.

TSDoc

TSDoc記法で書かれたファイルからドキュメントを生成するツール TypeDoc

/**
 * 在室している人のリストを返します。
 * @returns users - 在室している人の配列のPromiseオブジェクト
 */
async function listUsers () {
}

🤔 オブジェクトの配列ってどう表現したらいいんでしょうね.