大規模なコードベースを文書化する方法を理解するのに苦労しています。一連のコンポーネントがあり、そのほとんどにバックボーン モデル、ビュー、およびコレクションがあります。YUIdocs が標準ツールとして選ばれました。ドキュメントが実際に役立つことを確認したいのですが、業界ですでに決定されている可能性のあるいくつかの標準については確信が持てません.
以下を文書化するにはどうすればよいですか?
シンプルなバックボーン モデル:
define(['backbone'], function (Backbone) { return Backbone.Model.extend({ defaults: { foo: '', bar: '', baz: '' } }); });
モジュールのデフォルトにマージされる設定オブジェクトを受け入れるコンストラクター。YUIdocs に @default パラメータがあるようですが、オブジェクトをサポートしていないようです。
initialize: function (settings) { this.settings = _.extend(this.settings, settings); }
イベントやモデルなどの標準バックボーン パラメータ。
events: { 'click #foo' : 'bar' } model: foo