【问题标题】:How to document properties of a function and functional constructors in jsdoc?如何在 jsdoc 中记录函数和函数构造函数的属性?
【发布时间】:2015-04-06 09:54:00
【问题描述】:

例如,我将如何记录?

var f = function () { var g = function() {}; g.h = function(); return g; }

这不是我发明的模式。见http://bost.ocks.org/mike/chart/

【问题讨论】:

    标签: javascript methods properties closures jsdoc


    【解决方案1】:

    检查此link out。非常有用的参考。

    做这样的事情。

    /** 
    
    *@method 
    *@param
    
    * {string} parameterA used to process..... 
    * @description 
    * function is used to process...... 
    */ 
    

    Params 用于提及其类型的参数。描述描述了函数的作用。

    function a(parameterA){}
    

    【讨论】:

    • 我已阅读文档。它似乎更倾向于记录原型构造函数,我自己无法找到答案。
    • 做这样的事情 /** * ^method * ^param * {string} 参数A用来处理..... * ^description * 函数用来处理...... * / params 用于参数提及类型描述描述函数function a(parameterA){}用@替换^。 Stackoverflow 不允许 @....somthing
    • 请使用反引号将其重写为答案。
    猜你喜欢
    • 2013-12-09
    • 2018-12-10
    • 2015-02-10
    • 1970-01-01
    • 2014-01-26
    • 1970-01-01
    • 2016-08-26
    • 2023-03-26
    • 2015-07-12
    相关资源
    最近更新 更多