@param
Visual Studio 2017のインテリセンスがコールバックを理解できるように、を使用してコールバックを正しく文書化する方法を理解できません。
例えば:
/**
* @param {string} file absolute path
* @param {Function} callback called when done
*/
function loadFile(path, callback) {
/// code
}
コールバックは受け入れError
とstring
引数(Node.jsのスタイル)として、どのようにそれを文書化しますか?
このパターンは機能します:
/**
* @param {string} file absolute path
* @param {function(Error, string):void} callback called when done
*/
function loadFile(path, callback) {
/// code
}
void
ここでは、戻り値がないことを表し、コールバックの戻り値に置き換えることができます(例:{function(value):boolean}
述語の場合)。
わからないパラメータ名を文書化する方法。
この記事はインターネットから収集されたものであり、転載の際にはソースを示してください。
侵害の場合は、連絡してください[email protected]
コメントを追加