私は Java プログラミングのバックグラウンドを持っています。私はそこでドキュメンテーションを行う方法を知っています。Java環境でクラスの各メソッドと各属性を文書化できます。
昨年からMEANスタックを使ったWebアプリケーションを作っています。最初は、自分の理解のために 1 行のコメントを追加しただけです。Web アプリケーションを文書化する標準的な方法が必要だと思います。
大まかに、次のコードがあります。
- Angularjs コントローラー
- Angularjs ルート
- Angularjs サービス
- サーバー側 (ノード) で定義された MongoDb コレクション
- ExpressJS 構成コード
- ExpressJS ルートとそのハンドラー
- 残りの API
- Socket.IO コード
要するに、私はこれをしたい：
- コメント形式のコード内ドキュメント (標準的な方法)
- 別のドキュメントのワード ファイルまたは HTML ファイルを作成する
編集
Java で行われているのと同様のタイプのコード ドキュメントを作成したいという意味ではありません。標準的な方法で MEAN ベースのアプリケーションでそれを行う方法を理解したいです。MEAN ボイラープレートを使用している人は、クライアント側のコードとサーバー側のコードに別々のフォルダーがあることを知っています。その中には、構成、ルート ハンドラー、認証、ビューなどのための個別のフォルダーがあります。
ありがとう。