Comments (3)
用 JSDoc @typedef 嘛:
/**
* @typedef {{ name: string; level: number }} Person
**/
/** @types {Person[]} */
const persons = [{
{ name: "集鹄大叔", level: 9999 },
{ name: "胡子大叔", level: 1 },
}];
from styleguide.
那作为函数参数的时候该怎么注释呢?比如:
/**
* 数字数组参数注释
*
* @param {Array.<number>} nums 数字数组
*/
function showNums(nums) {
// ...
}
/**
* 对象参数注释
*
* @param {Object} user 用户
* @param {string} user.name 用户姓名
* @param {number} user.age 用户年龄
*/
function showUser(user) {
// ...
}
/**
* 对象数组参数注释
*
* @param {Array.<Object>} users 用户数组
* @param {string} users[i].name 用户姓名
* @param {number} users[i].age 用户年龄
*/
function showUsers(users) {
// ...
}
上面的第三个函数注释格式肯定不对,应该怎么去写这种注释呢?
from styleguide.
emm...
查阅了一些资料,答案如下:
/**
* Assign the project to a list of employees.
* @param {Object[]} employees - The employees who are responsible for the project.
* @param {string} employees[].name - The name of an employee.
* @param {string} employees[].department - The employee's department.
*/
Project.prototype.assign = function(employees) {
// ...
};
参考资料:
http://usejsdoc.org/tags-param.html
from styleguide.
Related Issues (20)
- 源码目录规范,需要细化
- 不建议要求同作用域的变量在function头部申明 HOT 1
- 对短路写法怎么看 HOT 4
- 我在我的翻译项目中引用了各位大神的Markdown代码规范。 HOT 4
- "user strict" 是否要求? HOT 2
- 是否要阻止对基础对象原型的拓展或修改 HOT 1
- 对 arguments.caller 和 arguments.callee 的使用有什么看法? HOT 2
- node-jscs 这个检查工具似乎不错 HOT 4
- 强制function声明在作用域头部
- 缩进使用 2 个空格还是 4 个空格 HOT 28
- 这个 UI 规范写得真好 HOT 1
- 4.2.1 錯字 :)
- “避免使用 /*...*/ 这样的多行注释。有多行注释内容时,使用多个单行注释。” HOT 1
- 颜色值强制不允许使用命名色值的疑问 HOT 4
- 点击2.4.8函数注释,链接失效? HOT 1
- 你们这项目还维护吗?代码风格检查工具还做不? HOT 1
- 你们css规范里url()函数之间没加逗号
- 生成的文件放源码中很容易冲突 HOT 2
- if, for等强制{}会不会更好点 HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from styleguide.