プロジェクトの文書化に jsdoc ツールキットを使用していますが、別のプライベート オブジェクト内のプライベート オブジェクトを文書化する問題の中にいます。
私はこの警告を受けました:
警告: ドキュメント化されていないシンボル testObject のメンバーとして接続をドキュメント化しようとしています。
しかし、testObject はドキュメントの出力に「 {Object} testObject 」として適切に表示されます。
以下は JavaScript ファイルのテストです。
/*
* @fileOverview Various Test functions.
* @author Regards
*/
/**
* @description testUtilsNameSpace 'namespace' helps
* @name testUtils
* @type Object
* @namespace
**/
(function($) {
'use strict';
/**
* @description minPageReached private var
* @private
* @type number
* @name testUtils#minPageReached
* @field
*/
var minPageReached = 0;
/**
* @description maxPageReached public var
* @type number
*/
testUtils.maxPageReached = 0;
/**
* @description testPrivate private function
* @inner
* @param {page} page Info on the page you want to request
* @type Function
* @memberOf testUtils
*/
var testPrivate = function(page){
console.log("testPrivate");
};
/**
* @description testPublic public function
* @param {page} page Info on the page you want to request
* @type Function
* @memberOf testUtils
*/
testUtils.testPublic = function(page){
console.log("testPublic");
}
/**
* @description loadDependencies function
* @type Function
* @memberOf testUtils
*/
var loadDependencies = function() {
};
/**
* @description testObject
* @private
* @field
* @name testUtils#testObject
* @type Object
*/
var testObject = {
/**
* @description connection object
* @field
* @name testObject#connection
* @type Object
*/
connection: {
}
}
})(window.jQuery);