: How do I start to document an API that uses C#? I have no experience writing API documentation, but a need has arisen for it at my company. However, the only guides I can find for API Documentation

Vote Up Vote Down

If the API you're going to document is a REST API, Tom Johnson has this excellent free online course, Documenting REST APIs.

If that doesn't fit your needs, Stack Overflow has a couple of topics that might also be interesting:

C# Doc Generator has a list of tools to consider.
Creating great API doc: Tools and techniques.

An important API doc tool that's trending right now is the Swagger Editor, which includes support for C#. For a great example of API doc, check out the Swagger examples.

(0)

Vote Up Vote Down

Look at API documentation for C#, such as that on the Microsoft site (see here), or check out one of the multitude of repositories on Github.

Basically, API document the ways users interact with your product. You have to specify fields, classes, methods, constants, etc. Look at the Java API to see a systematic way to do this and then adapt it to your product.

(0)