Post History
The purpose of API documentation is to explain how to use the API. Providing sample code of how to use key features is a good way to demonstrate the intended usage. A good example of this is the ...
Answer
#3: Attribution notice added
by
System
·
2019-12-08T08:04:45Z (over 4 years ago)
Source: https://writers.stackexchange.com/a/33591 License name: CC BY-SA 3.0 License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision
by
sphennings
·
2019-12-08T08:04:45Z (over 4 years ago)
The purpose of API documentation is to explain how to use the API. Providing sample code of how to use key features is a good way to demonstrate the intended usage. A good example of this is the [ZMQ guide](http://zguide.zeromq.org/page:all). It has example code in a large number of languages to go with each of the of the concepts discussed. They combat the bloat by displaying links to the example code in every language the library is supported in. Only when a link is clicked on is the code displayed.
#1: Imported from external source
by
System
·
2018-01-25T21:00:25Z (about 6 years ago)
Original score: 2