Over a million developers have joined DZone.

Is API Documentation a Waste of Time?

· DevOps Zone

The DevOps zone is brought to you in partnership with Sonatype Nexus. The Nexus suite helps scale your DevOps delivery with continuous component intelligence integrated into development tools, including Eclipse, IntelliJ, Jenkins, Bamboo, SonarQube and more. Schedule a demo today

Application Programming Interface (API) documentation is a subset of Software Documentation. It is often embedded within the source code. API documentation is written in plain language which describes the functionality and usage of a particular type or method or variable.

I've evaluated many open source projects and realized that APIs are often not documented well. It is important for the community to know what the reasons behind this.

To try to find the reason behind the lack of API documentation, I created a survey. You can find it here.

We appreciate your time and effort. Your participation is highly valuable.

Thanks in advance!

The DevOps zone is brought to you in partnership with Sonatype Nexus. Use the Nexus Suite to automate your software supply chain and ensure you're using the highest quality open source components at every step of the development lifecycle. Get Nexus today


The best of DZone straight to your inbox.

Please provide a valid email address.

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}