search

amosproj / amos2021ss07-bike-nest

MIT License
1 stars 0 forks source link

API Documentation #147

Open s-kruschel opened 3 years ago

s-kruschel commented 3 years ago

Research / Work on the ability to create source code documentation right out of the source code.

rmandlx commented 3 years ago

For Java you can easily generate a html documentation out of source code. It's important that the comments are formatted this way:

/**
 * Comment here.
 */

This is the Javadocs comment style. There are probably free tools out there, that can generate a documentation, but I personally use the integrated tool that IntelliJ offers. I already generated a first version, that can be found in Backend/docs (Payment Branch currently)

On the frontend side there are most certainly also tools, that can be used to generate documentation from javascript code. But we would probably also have to use a specific comment style, so that it works?