How to interpret API documentation function parameters?

后端 未结 4 623
有刺的猬
有刺的猬 2020-11-22 00:35

Is there a standard to interpret the syntax of function interfaces in API documentations and if yes, how is it defined?

Here is an example on how to change the color

4条回答
  •  野的像风
    2020-11-22 01:11

    I had this same question a while back and somebody pointed me to Extended Backus–Naur Form.

    It makes sense because programming can be used to create potentially limitless outcomes. The documentation can not display an example for every possible case. A good example of common use I helpful but once you can read the underlying syntax you are able to create your own code.

提交回复
热议问题