缺少JSDoc @param“ props.children”类型和缺少的JSDoc @param“ props.children”类型使用React Native FunctionalComponents

编程问答 2022-08-12

问题描述

我正在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 (将#修改为@）

jsdocreact-nativereactjsreactjstsdoc