How to document array elements?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
Hi,
I have a function that takes an array of strings.
Something like:
function myFunc(args) {
var a = args[0];
var b = args[1];
}
But I want to specify what each element within the array represents.
How can I achieve that? I tried with something like:
/**
* @param {String[]} args
* @param {String} args.0 - attribute name.
* @param {String} args.1 - value to set.
*/
But obviously this is wrong since they are interpreted as properties.
Of course, I also tried with args[0] but I get an error at jsdoc generation phase.
Finally, Google did not help this time. :/
Any suggestion?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the array-parameter examples in the issue and the JSDoc documentation for parameter syntax. Determine whether positional array elements are supported, then document the supported form or clarify the limitation with a concrete example. The issue has no named file or test, so the relevant documentation entry point is not identified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100