gpt4 book ai didi

javascript - 重要 ES6 代码的文档示例

转载 作者:行者123 更新时间:2023-11-30 20:58:55 29 4
gpt4 key购买 nike

<分区>

我正在努力寻找对文档 ES6 代码的体面的文档示例/引用,例如某种 ES6 文档的备忘单。

我想对齐 JSDoc 文档,但是在这个问题的最常见答案中,我只能设法找到琐碎代码文档,而不是适合新 ES6+/React 语法的文档或更复杂的参数,如数组、映射、参数反序列化等。

例如does-javascript-have-a-standard-for-commenting-functions仅给出有关具有标准参数的常规 JS 函数的文档示例。

我想找到规则/很好的方法来记录这样的事情,如何指示需要或不需要的参数等。

我想记录的方法示例

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

}

我能想到这样的事情

**
* 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 }),是嵌套的 function({ param1: { nestedParam1、nestedParam2 }) 或重命名为 function({ param1: name1 }) 以及如何处理组合类型,如 xxx 数组

我已经在多个方法声明中使用了 PropTypes,但它们仅在使用 React 组件时有效,但在编写实用程序函数等时不太有用。

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