わかりやすいES6コードのドキュメント例

Question

ES6ドキュメント用のいくつかの種類のチートシートのように、ドキュメントのES6コードへの適切なドキュメントサンプル/参照を見つけるのには苦労しています。

新しいES6 + /リアクト構文またはより複雑なのparamsに合うドキュメント私は、JSDocのドキュメントに合わせたいのですが、この質問への最も一般的な答えの中で、私は唯一の些細なコードのドキュメントを見つけるために管理することができ、そしてません

たとえば、does-javascript-have-a-standard-for-commenting-functionsは、標準のparamsで標準のJS関数に関するドキュメンテーションの例のみを示しています。

私は

になど、必要とされるのparamsかどうかを示すために、どのように、このような何かを文書化するためのルール/素敵な方法を見つけるために、私は

const signInWithCredentials = ({ emails, password, authentication_code }, options) => { 

} 

を文書化したいメソッドのexempleが欲しいです

私はこの

** 
* Attempts sign in with any possible credentials pair 
* (Provide either email + password, or an authentication_code and a provider name in the options 
* @param { 
* emails: { Array<String> }, 
* password: { String }, 
* authentication_code: { String } 
* } - credentials 
* @param { Object } - options 
* @param { String } - options.provider 

のようなものを考えることができる。しかし、私は本当に名前function({ param1, param2 })を持っていない非直列化されたのparamsをどのように扱うか本当にわからないんだけど、012ネストされていますかはfunction({ param1: name1 })と改名しているなどの外部のユーティリティ関数を書くとき、私はすでにいくつかのメソッド宣言のためのPropTypesを使用していますが、コンポーネントを反応させるの使用しているとき、彼らはのみ動作しますが、あまり有用である

XXXの配列、のような構成のタイプを処理する方法反応の

Answer 1

ネヴァーマインドは、私はちょうどJSDocのは、ドキュメントのサンプルで公式ページを持っていたし、これはdestructuration

http://usejsdoc.org/tags-param.html

Documenting a destructuring parameter 
/** 
* Assign the project to an employee. 
* @param {Object} employee - The employee who is responsible for the project. 
* @param {string} employee.name - The name of the employee. 
* @param {string} employee.department - The employee's department. 
*/ 
Project.prototype.assign = function({ name, department }) { 
    // ... 
}; 

に関するセクションが含まれていることを実現しました