gpt4 book ai didi

jsdoc - 在 JSDoc 中记录对对象/函数的更改的正确方法是什么?

转载 作者:行者123 更新时间:2023-12-03 14:59:47 26 4
gpt4 key购买 nike

假设我有一个接受一个参数的函数:

/**
* @summary Some function.
*
* @since 1.0.0
*
* etc.
*/
function func( a ) {
// do stuff...
}

然后几个版本后来添加了对第二个参数的支持。在 PHPDoc 中你可以添加额外的 @since条目以保留特定于该元素的更改日志:
/**
* @summary Some function.
*
* @since 1.0.0
* @since 1.2.0 Parameter b was added, because reasons.
*
* etc.
*/
function func( a, b ) {
// do stuff...
}

这样人们很容易看到何时引入了这样的更改。 JSDoc 中是否有元素“更改日志”标准?

我检查了 page for @since on usejsdoc.org ,但没有提到任何类似的东西,也没有提到应该用于它的不同标签。

最佳答案

自从您提出问题以来已经有一段时间了,但现在有这样一个同名标签: @since

(和 FWIW,如果您想要特定方法的版本,可以使用 @version 。)

关于jsdoc - 在 JSDoc 中记录对对象/函数的更改的正确方法是什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/39750032/

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com