如何解决缺少JSDoc @param“ props.children”类型和缺少的JSDoc @param“ props.children”类型使用React Native FunctionalComponents
我正在React Native项目上使用JSDoc和TSDoc。
这是文件:
User
我有两个警告:
在第二个@param上:
import React,{ createContext,useContext,FC } from 'react'
import useUserData,{ UseUserDataType } from './useUserData'
import { AuthContext } from './FirebaseContextProvider'
import { AuthUser } from '../../common'
// Initial state
const initialUserDataContext = {
userData: {},} as UseUserDataType
// Create the context objects
export const UserDataContext = createContext<UseUserDataType>(initialUserDataContext)
/**
* Context provider for user data from firebase
*
* @param props -
* @param props.children - application parts that are dependent on user data.
* @returns a context provider for user data
*/
const DataContextProvider: FC = ({ children }) => {
const { user } = useContext(AuthContext)
// UserData
const userData = useUserData(user as AuthUser)
return (
<UserDataContext.Provider value={userData}>
{children}
</UserDataContext.Provider>
)
}
export default DataContextProvider
在JSDoc行的开头:
tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characterseslinttsdoc/syntax
我不太了解如何记录我猜想的道具。有任何见解吗?
谢谢
编辑:
如果我将类型添加为@param {Type},则TSDoc会抱怨,因为它是TypeScript:
Missing JSDoc @param "props.children" type.eslintjsdoc/require-param-type
暂时删除规则,等待查看是否有更好的配置。
tsdoc-param-tag-with-invalid-type: The @param block should not include a JSDoc-style '{type}'eslinttsdoc/syntax
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。