将注释写在action creator函数的顶部,而非函数定义的地方。
示例代码:
/**
- 创建一个新的用户.
- @param {string} name - 用户名字
- @param {string} email - 用户邮箱
- @returns {object} 包含用户信息的action.
*/
export const createUser = (name, email) => {
return {
type: 'CREATE_USER',
payload: {
name,
email
}
}
}
在上述示例代码中,注释位于action creator函数的顶部,这样它就能被正确的显示了。