DEV Community

Discussion on: What are some examples of great documentation?

Collapse
 
galvao profile image
Er Galvão Abbott

I am - not without some bias, I suppose - a huge fan of PHP's Documentation. It has all the good points:

  • Function/Method signature
  • Parameter, Return and Exceptions described
  • Syntax highlighted code examples
  • Warnings against common mistakes
  • Related functions/methods
  • Ranked (by vote) Dev comments

And it's even downloadable in HTML and CHM formats. Honestly, I don't know what else you could ask for in language docs.