如何使用JSDocs注释ReactJS状态-完整的“类”组件属性
JSDoc是一种用于为JavaScript代码添加注释的工具，它可以提供代码的文档化和类型检查。在ReactJS中，我们可以使用JSDoc注释来描述React组件的状态和属性。
对于一个完整的"类"组件属性，我们可以使用以下JSDoc注释：
/**
* @class
* @extends React.Component
* @classdesc React组件描述
*/
class MyComponent extends React.Component {
constructor(props) {
super(props);
/**
* 组件状态描述
* @type {Object}
* @property {string} name - 名称属性
* @property {number} count - 计数属性
*/
this.state = {
name: '',
count: 0,
};
}
/**
* 组件渲染方法
* @returns {JSX.Element} React元素
*/
render() {
return (
<div>
{/* 组件内容 */}
</div>
);
}
}
/**
* 组件属性描述
* @typedef {Object} MyComponentProps
* @property {string} name - 名称属性
* @property {number} count - 计数属性
*/
/**
* @typedef {Object} MyComponentState
* @property {string} name - 名称属性
* @property {number} count - 计数属性
*/
/**
* @type {MyComponentProps}
* @property {string} name - 名称属性
* @property {number} count - 计数属性
*/
MyComponent.propTypes = {
name: PropTypes.string,
count: PropTypes.number,
};
/**
* @type {MyComponentProps}
* @property {string} name - 名称属性
* @property {number} count - 计数属性
*/
MyComponent.defaultProps = {
name: '',
count: 0,
};上述代码中，我们使用了JSDoc注释来描述React组件的状态和属性。在组件的构造函数中，我们使用@type标签来描述组件的状态对象，并使用@property标签来描述状态对象的属性。在组件的render方法上，我们使用@returns标签来描述返回的React元素。
此外，我们还使用了@typedef标签来定义组件的属性类型和状态类型。在propTypes和defaultProps属性上，我们使用@type标签来指定属性类型，并使用@property标签来描述属性的具体信息。
需要注意的是，以上示例中的JSDoc注释只是一种常见的写法，具体的注释格式可以根据团队或个人的喜好进行调整。
对于ReactJS状态-完整的"类"组件属性的应用场景，它适用于需要管理内部状态并根据状态变化进行渲染的复杂组件。这种组件通常包含一些交互逻辑和数据处理，可以通过状态的变化来更新组件的显示。
推荐的腾讯云相关产品和产品介绍链接地址如下：
- 腾讯云云服务器（CVM）：提供可扩展的云服务器实例，用于部署和运行应用程序。
- 腾讯云云数据库MySQL版：提供高性能、可扩展的云数据库服务，适用于存储和管理数据。
- 腾讯云对象存储（COS）：提供安全、可靠的对象存储服务，用于存储和管理大规模的非结构化数据。
- 腾讯云人工智能：提供丰富的人工智能服务，包括图像识别、语音识别、自然语言处理等，可用于开发智能应用。
- 腾讯云物联网（IoT）：提供全面的物联网解决方案，用于连接和管理物联网设备，并实现设备间的通信和数据交互。
请注意，以上链接仅供参考，具体的产品选择应根据实际需求和项目要求进行评估和决策。
相关·内容
2回答
我使用的是reactjs和bootstrap v3.0，但我在其中找不到任何折叠类，所以我在scss中定义了它。问题是togglebutton不起作用，或者在div上没有触发toggleevent：
toggle(e) {
console.log('testing e',e)
if (e.target.class === 'collapse') {
e.target.className = 'collapse.in'
} else {
e.targe
浏览 1提问于2016-11-16得票数 4
回答已采纳
1回答
我搜索了类似的问题，但没有一个能满足我的疑问。在以下情况下，我如何将" this“更改为react功能组件：<SimpleStorage parent={this}/>，该组件属于库(称为react-simple-storage)，并且是在功能组件中编写的。我看到的所有例子都涉及到this.state、this.object或this.function，但没有一个是单独涉及this的。 const Books = () => {
...
return <Router>
<SimpleStorage parent={
浏览 12提问于2021-07-23得票数 0
我是新的反应(只有一个在线课程)，并发现魔术道具和状态。我意识到道具是不变的，状态是可变的。我越来越清楚他们的用途，但有一点我想澄清，我一直未能在网上找到。
因此道具可以从父传递到子，当它们被传递时，保存道具的变量的名称可以被更改。当状态或其值传递给子组件时，还会向子组件传递一种机制，以便子组件能够在父级修改状态。
我希望这是正确的，因为到目前为止，这是我所理解的道具和状态。
现在我有了一个项目，其中我有"App.js“，它是以"Home.js”作为其子项目的最顶端的父级。我计划在两者中都使用state。但是，state in App.js是一种全局状态(我不想使用redux)
浏览 4提问于2022-04-09得票数 0
回答已采纳
我正在构建一些React，有时我希望将由displayName呈现的组件类型记录到控制台，JSX在显示组件名称时使用该类型。
从组件的上下文中，如何访问displayName属性？
例如，如何使本例中的console.log语句显示组件的displayName？
var Hello = React.createClass({
displayName: 'HeyHey',
render: function() {
console.log(this.displayName);
return <div>Hello {th
浏览 6提问于2014-07-12得票数 49
回答已采纳
2回答
我试图将多个组件的状态(actiu)设置为false，通过类引用它们。当我单击行中的标签时，行中所有元素的actiu状态变为false，如何实现这一目标？这是我的组件树：
有一些Blade模板语法可以生成每一行标签。
var RespostesBox = React.createClass({
render: function() {
return (
<div className="form-group">
<?php $zenbatu = 0; ?>
@foreach($preguntes as $p)
浏览 2提问于2015-05-31得票数 2
下面是父类
class Root extends React.Component {
constructor(props) {
super(props);
this.state = {
word: Words,
};
}
changeTheWord(i) {
this.state.word.changeWord(i);
}
render() {
return (
<div className="game">
<ul>
<
浏览 0提问于2018-09-24得票数 1
我正在为用户在UI中为产品列表创建一个过滤器功能。但我有一个问题，我不知道，也从来没有尝试过这个功能，所以我真的很难解决它。我只有一天的时间去做那件事，所以我很困惑。
这是我的Dropdown组件
import React from "react";
import { Dropdown as BootstrapDropdown } from "react-bootstrap";
import PropTypes from "prop-types";
import "../Dropdown/index.css";
const Dr
浏览 2提问于2020-09-09得票数 2
如何对状态使用shouldComponentUpdate？
我可以检查：
shouldComponentUpdate(nextProps, nextState) {
return this.state.value != nextState.value;
}
但这对州来说没有任何意义。因为如果我改变状态(this.setState({value: 'newValue'}))，this.state将等于nextState。
例如，onClick事件：
handleClick() {
this.setState({value: 'newValue'});
}
浏览 1提问于2016-10-08得票数 32
回答已采纳
跳到我的公司的一个成熟的React应用程序中，但仍然在学习它的细节。我有一个评论框，当提交时，将加载文本框和css，但实际的评论不会显示，直到您刷新页面。我试着玩弄状态逻辑，但到目前为止还没有取得任何进展。我应该能够点击提交，然后看到评论显示谁提交了它和他们提交它的时间。有什么想法吗？
派单商店：
public addComment(comment: string, dispatchId: string) {
return this.api.post(`/dispatch/${dispatchId}/comment`, {
comment });
浏览 2提问于2021-10-11得票数 1
2回答
我有一个关于react构造器的问题，因为我使用了angular，并且习惯了绑定行为。我不知道如何通过构造函数来改变属性。并解释我为什么不能做到这一点，并解释我如何才能实现我的目标。
class example extends React.Component {
constructor(){
super();
this.changeExample = this.changeExample.bind(this)
this.valueExample = 'Hello Example'
}
changeExample() {
this.valueExamp
浏览 1提问于2018-06-09得票数 0
我是reactJS的新手，我陷入了一个问题。我有一个按钮在标题，需要切换一个类别‘显示’在一个菜单，这是在其他文件。我试图使用全局状态，但不知道如何做到这一点。以下是我所做的；
布局文件
import React, { useState } from "react";
// importing header / menu etc.
function LayoutHome({ children }) {
const [state, setState] = React.useState({ MsgMenu: 'messages-dropdown' });
cons
浏览 6提问于2022-04-02得票数 0
我有一个带有单字符属性名称(设计约束)的TypeScript接口。我想使用JSDoc来记录这个接口，以帮助在vscode中实现自动完成。
下面是当前的界面：
export interface ISource {
b: string
d: string
f: string
h: string
M: number
L: number
P: number
n: string
r: string
u: string
p: string
}
非工作尝试包括：
/**
* @typedef {object} ISour
浏览 9提问于2019-10-25得票数 19
回答已采纳
2回答
我正在从ReactJs转移到React-Native，并发现了这个函数结构
class Button extends React.Component<{
title: string,
onPress: () => any,
color?: ?string,
hasTVPreferredFocus?: ?boolean,
accessibilityLabel?: ?string,
disabled?: ?boolean,
testID?: ?string,
}> {
static propTypes = {
/**
* Text
浏览 2提问于2018-06-02得票数 5
3回答
我试着理解ReactJS的例子：
class App extends Component {
constructor(props) {
super(props);
this.state = {date: new Date()};
this.date = new Date(); // why not just this.date
}
render() {
return (
<div>
<h1>App Hello, {this.state.date.toLocaleTimeString()}.
浏览 3提问于2017-02-19得票数 3
回答已采纳
我能够理解我正在处理的代码库中的组件的定义：
@PureRender
export default class UiWidget extends Component {
}
我尝试在googling中了解属性@PureRender的意义，该属性用于修饰组件，但没有获得任何相关链接。有人能帮助我理解将此属性应用于reactJs组件的影响吗？
浏览 7提问于2017-05-02得票数 0
回答已采纳
1回答
我正在尝试在react中创建组件。我处于学习模式。所以，也许我做的完全错了。下面是我的代码
My Code on sandbx
class MegaMenu extends React.Component {
public render() {
return (
<div className={styles.MegaMenu}>
<div className={styles["menu-container"]}>
<div className={styles.menu}>
浏览 0提问于2019-12-12得票数 0
我有多个表单，它们共享许多呈现的字段，但不是全部。因此，我已经构建了一个基本表单，并希望在必要时对其进行扩展。
问题是:如果我的基组件有A、B、C字段，扩展的组件应该有A、D、C字段。我怎么表现出来的？根据最佳实践，我的渲染应该是什么样的呢？下面是一个示例基表单(实际表单非常大)：
var BaseForm = React.createClass({
getInitialState: function() {
return {data:FormStore.data};
},
defaultProps: function(){},
render: function () {
浏览 0提问于2017-02-25得票数 0
回答已采纳
在官方上，它说要访问传递到重定向到的组件中的状态，可以使用this.props.location.state
但是，我没有使用类组件，因此我没有this.。
如何在重定向的组件中访问传递的状态？
浏览 21提问于2020-05-24得票数 0
当我的应用程序加载时，运行下面的查询，并在浏览器中显示来自数据库的结果。但是，我的应用程序也有一个提交按钮。在按下submit按钮的同时传递来自submit的时间戳输入时，如何运行整个组件？
handleSubmit(event) {
event.preventDefault();
console.log(this.state.inputValue)
this.state = {
inputValue: new Date(document.getElementById("time").value).valueOf()
};
console.log(t
浏览 2提问于2018-08-02得票数 0
我想在每次点击div时将它的高度加倍。
每当我单击一个按钮时，我都在考虑对div应用一个额外的CSS类。CSS概念将类似于：
#divToBeDoubled {
height: 100px;
&.doubleHeight{
height: selfHeight*2
}
}
我如何使用Reactjs和SCSS来实现这一点？
浏览 18提问于2018-07-27得票数 0
回答已采纳
我是个新手。
class Home extends Component {
logOut(){
console.log('log out in side home js');
this.props.LogOutAction();
localStorage.setItem('loginFlag', null);
}
render(){
return(
<d
浏览 0提问于2017-07-07得票数 0
基于本页面上的教程：https://spring.io/guides/tutorials/react-and-spring-data-rest/，我正在尝试创建Spring REST API后端的前端。我对这些示例进行了一些修改，以适应我在春季的项目，但不幸的是，它现在不能工作。现在，我只想在主页上从数据库中写出几条记录。此时将显示空白页，而不是数据库中的文本。 在这里，您可以看到curl打印输出： C:\Users\Admin>curl http://localhost:8080/getAllDelegations
[{"delegationId":3,"
浏览 15提问于2020-04-14得票数 1
我是一个编程新手，已经用JS完成了一些在线课程，目前正在学习ReactJS Tic Tac Toe tutorial ()。我理解一般的逻辑，但对Board类中的构造函数所做的事情感到困惑：
class Board extends React.Component {
constructor(props) {
super(props);
this.state = {
squares: Array(9).fill(null),
};
}
renderSquare(i) {
return <Square value={i} />;
浏览 0提问于2018-01-12得票数 0
2回答
因此，我有一个反应引导导航，我想让其中一个导航项目打开和关闭一个引导模态组件。
我有这样的工作：
import React, { Component, render } from 'react';
import { Navbar, Nav, NavItem, NavDropdown, MenuItem, Modal, Button } from 'react-bootstrap';
export default class NavigationBar extends Component {
constructor() {
super();
this.s
浏览 0提问于2017-03-14得票数 2
回答已采纳
我正在尝试创建一个表单，在这个表单中，我将文本输入和文件输入相加在一起，直到我决定实现上述文件输入为止，一切都很正常。
这是我的密码：
const [producerData, setProducerData] = useState({
title: '',
text: '',
address: '',
status: '',
avatar: '',
});
const { title, text, address, status, avatar } = producerD
浏览 3提问于2020-04-25得票数 0
我正在尝试使用componentDidMount将axios中的数据设置为组件状态，但它不起作用
我通过这个简单的代码检查了它
import React, { Component } from "react";
import ReactDOM from "react-dom";
import axios from 'axios';
import "./styles.css";
class App extends Component {
constructor(props){
super(props);
sta
浏览 1提问于2019-11-04得票数 1
我在React组件中有一个属性name。我正在尝试使用setState来修改这个属性。但是，在setState中为该属性赋一个新值没有任何效果。请在下面找到我的示例代码。
export const Test = ({
name,
changeState = function (newName) {
this.setState({name: newName}, () => console.log('Name after setState # ' + name)); //prints old value
console.log(name); // Do
浏览 0提问于2018-03-12得票数 0
在外面，这似乎不是问题，但当我打开DevTools，然后转到网络标签。它显示发出了500个请求。那么，我如何重构代码才不会发生这种情况呢？
useEffect(() => {
const fetchData = async () => {
try {
const response = await axios.get(
"https://raw.githubusercontent.com/XiteTV/frontend-coding-exercise/main/data/dataset.json"
浏览 10提问于2021-05-12得票数 0
在遵循文档的同时，我也在尝试遵循最佳实践。而无需创建许多一次性方法来处理可维护性方面的问题。
总之，我试图实现兄弟元素之间的一种状态，至少在视觉上是一种“活动”状态。有了像jQuery这样的东西，我会简单地做..
$(document).on('.nav-component', 'click', function(e) {
$('.nav-component').removeClass('active');
$(this).addClass('active');
});
然而，在react中，它本身
浏览 0提问于2015-10-24得票数 1
1回答
我正在使用React实现一个非常简单的图表页面，其中包含以下组件: Designer: has columns。Column:如果有工具，它会呈现一个图表。图表:将绘制一个Highchart。
问题是当我更改任何列的状态时的性能，所以我在设计器中调用this.setState({columns: columnsArr})，React将呈现所有列，例如，如果我们有60列，这将花费很长时间。
我读到React只在组件的属性发生变化时才呈现组件，所以对于column组件，如果一列发生了变化，它不应该呈现所有列。那么我在这里错过了什么呢？
下面是我的代码：
`
class Chart extends
浏览 0提问于2018-07-25得票数 1
我正在做一个ReactJS项目，在这个项目中，您可以在按generate按钮时生成一个随机活动。我正在对我的api进行一次提取，以显示其中的一些数据。这个很好用。现在，每当我单击generate按钮(在home组件中)时，我都希望进行获取并显示返回的数据。因此，generate按钮必须执行一个新的获取和刷新组件。此外，在默认情况下，它必须是空的。我搜索了一段时间，找不到相关的答案。你们有些人能帮我吗？谢谢。
提取组件
import React from "react";
export class ItemLister extends React.Component {
浏览 0提问于2017-10-05得票数 10
回答已采纳
1回答
我是编程界的新手，我的反应(利用新冠肺炎的时间变得更好.)。当用户单击“注册”按钮时，我试图呈现一个组件。我的目标是将其显示为屏幕中间的弹出，供用户填写表单。(我正在使用Visual代码和react生成器)
我无法实现它，如果我console.log结果为true/false (取决于某一条件)，它将正确工作，所以我想问题在于我“调用”组件的方式。
如果有人能指点好的方向，我会很高兴的！
App类，其中处理程序函数正在调用假定的弹出div
import React from "react"
import Header from "./UI/Header";imp
浏览 0提问于2020-03-24得票数 1
回答已采纳
在jQuery中，我们可以轻松地设置切换事件，
$('div').click(function(){
$('div').toggleClass('active');
});
而是如何用jQuery在reactjs中实现这类事情。
浏览 0提问于2015-11-18得票数 1
1回答
我有一个带有小部件区域的仪表板。Position 1可以包含一个时钟、一个天气小部件或10个或12个其他小部件。位置2、3、4等也是如此。
在Vue中，我会用来动态地包含一个小部件。这样做的好处是我只能更新特定的小部件。
我在React中遇到的问题是，我发现自己在一个主窗口小部件容器中就像这样
if (currentWidget === 'clock') {
return (<Clock settings='clockSettings' />)
}
if (currentWidget === 'weather') {
return
浏览 0提问于2020-03-17得票数 0
1回答
我是ReactJS的新手。我应该希望从其他组件中重新呈现一个组件。例如，我插入并显示了组件。我想在单击insert component的submits按钮后重新渲染显示组件。
显示组件：
import React from 'react';
import Fetch from 'react-fetch';
import styler from 'react-styling'
class Show extends React.Component {
render() {
return (
浏览 2提问于2017-08-04得票数 0
回答已采纳
我是新来的反应，我很困惑它应该如何运作。
我想做一个小的评估应用程序与问题，节，和一个总计部分。
我在主页组件中标记了如下所需的内容：
export default class Home extends React.Component {
public render() {
return <SurvivalTest>
<Section title="Requirements">
<Question>
Does the pro
浏览 4提问于2017-12-05得票数 2
回答已采纳
2回答
IT解决了，代码正常，问题是不正确的导入。
这是一个很长的帖子(由于代码样本)。我将感激您的耐心，并将非常感谢您的帮助！
我们有一个RoR后端，并在前端做出反应，我们使用alt作为通量的实现。我们还使用babel将ES6编译成ES5。因此问题是，由于两个错误，我无法呈现组件。
首先是Uncaught TypeError: Cannot read property 'map' of undefined
它出现在MapPalette组件的呈现函数上：
render() {
return (
<div>
{this.state.featureCat
浏览 5提问于2015-04-22得票数 1
回答已采纳
我正在使用包动态生成表单。
我使用以下链接生成了一个简单的登录表单：
构建之后，它将创建一个JSON。然后，我使用那个JSON生成一个表单，但是当我在fulfill all validation of form之后提交表单时，它总是在disable mode中显示为什么？
我们如何再启用按钮?？当我的promise is resolved和如何重置表单后，提交它？
这是我的代码，
onSubmit={i => {
alert(JSON.stringify(i.data));
var promise1 = new Promise(function(resolve, reject)
浏览 5提问于2019-11-03得票数 2
回答已采纳
为什么我不能从ReactJS的“外部”访问组件方法？为什么它是不可能的，有什么方法可以解决它吗？
考虑下面的代码：
var Parent = React.createClass({
render: function() {
var child = <Child />;
return (
<div>
{child.someMethod()} // expect "bar", got a "not a function" error.
浏览 21提问于2014-07-19得票数 205
回答已采纳
在中，有关于Refs and Functional Components的声明
您可能不会对功能组件使用ref属性，因为它们没有实例：
function MyFunctionalComponent() {
return <input />;
}
class Parent extends React.Component {
render() {
// This will *not* work!
return (
<MyFunctionalComponent
ref={(input) => { this.text
浏览 5提问于2017-06-10得票数 11
我正在为一个项目使用eslint和google样式指南，但是它会为类组件抛出jsdoc错误，而不管jsdoc是否包含@return或权证。
以下将引发此错误：
...
112. /**
113. * DashboardBanner is the top bar of the body.
114. */
115. class DashboardBanner extends React.Component {
116. /**
117. * Caption for the constructor
118. * @param {type} caption here
119.
浏览 2提问于2021-06-30得票数 2
回答已采纳
2回答
我需要在组件(甚至页面)完全呈现后切换css类，以便在页面加载时显示相关属性。
我该怎么做，最好没有jQuery？
如果我在componentDidMount中切换一个组件的类，动画实际上不会发生。
浏览 7提问于2014-11-13得票数 7
回答已采纳
我试图在React中从子组件内部的父组件调用方法。这是我的父组件的代码：
import Video from 'Video/Video';
class CaseHeader extends React.Component {
constructor(props) {
super(props);
// Bind functions
this.videoComponentDidMount = this.videoComponentDidMount.bind(this);
}
videoComponentDidMount() {
c
浏览 2提问于2017-09-04得票数 0
回答已采纳
在命令npm jsdoc的帮助下，我已经在我的解决方案中安装了Jsdoc。在方法上，我用注释定义为：-
/**
* @param {object} state person/thing you want to say hello to.
* @param {object} action
* @returns {object} state
*/
现在的问题是如何生成文档?生成文档的命令是什么？
浏览 5提问于2017-01-27得票数 2
回答已采纳
2回答
正如标题所问的，在ReactJS组件中使用"state“和"this”有什么区别？如果我控制台记录组件的"this"，那么使用"this“声明的状态和属性将出现在对象内的同一”级别“。
"state“似乎是包装组件属性的附加属性吗？如果我想将"state“作为支柱传递给另一个组件，那么传递"this”就足够了吗？
例如：
state = {
isPastDelay: false,
};
componentDidMount () {
this._delayTimer = setTimeout(() => () {
浏览 0提问于2018-07-04得票数 0
回答已采纳
我一直在改进我学习使用基于类组件的代码。在没有参数的函数中，我取得了部分成功。但其余的都没有改变。
什么起作用：
这
const About = () => (
<div>
<h2>About</h2>
</div>
)
至
class About extends React.Component {
render() {
return (
<div>
<h2>About</h2>
<p>The content is h
浏览 4提问于2017-12-14得票数 1
回答已采纳
2回答
我想将一个类作为jsdocs类型引用到另一个文件中。
就像这样
// src/models/MyClass.js
/**
* @class
* @alias module:MyClass
*/
class MyClass {
foo() {
}
}
// src/controllers/index.js
/**
* @param {*} context
* @param {module:MyClass} context.myClass
*/
const myFunction = (context) => {
const bar = context.MyClas
浏览 6提问于2022-08-04得票数 0
2回答
在ReactJS中，HOC和提升状态有什么不同？在这两种方法中，我们可以共享状态，有什么区别？
浏览 0提问于2020-08-25得票数 3
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
对象存储
即时通信 IM活动推荐
腾讯云开发者
