search

Home  >  Q&A  >  body text

javascript - Is there any standard for parameter description in js?

When I looked at the axios document today, I saw that the parameter description was written like this:

axios.request(config)

axios.get(url[, config])

axios.delete(url[, config])

axios.head(url[, config])

axios.options(url[, config])

axios.post(url[, data[, config]])

axios.put(url[, data[, config]])

axios.patch(url[, data[, config]])

I found that many open source projects use similar instructions when describing parameters, such as vuejs, jquery, etc. I want to know if this is a convention? Or are there any special regulations? Ask for advice

世界只因有你世界只因有你2722 days ago782

reply all(1)I'll reply

  • 某草草

    某草草2017-06-30 09:58:26

    [] represents optional parameters,

    reply
    0
  • Cancelreply