Documentation

[shadowmouse]

First off I wasn't sure if this should be lounge or general but it would apply to all languages so I put it here.

Anyway, I'm currently facing the problem of having to document every single algorithm that I'm using, and that means that my current method of using doxygen to explain what each function and class does is not sufficient. What software would you guys suggest for making flowcharts (or pseudocode, but flowcharts are generally preferred and actually require software other than notepad) to represent algorithms? I've tried various things like yEd(which I find awkward) and gliffy(which lasts of 30 days), but have never really found anything that's perfect.

Even better, is there any software that will convert code to a flowchart, or make one from comments like doxygen does with normal documentation?

[Lachlan Easton]

I generally use https://www.draw.io/ for that kind of thing.

[MiiNiPaa]

+1
draw.io is awesome

[shadowmouse]

Thanks for the suggestion, I've just had a quick look and it looks really good. Is it free or does it start charging after a certain period?

[MiiNiPaa]

We have always made, and will continue to make, the promise that draw.io online will be available for free for personal, academic and charitable use.

https://support.draw.io/questions/360467

[shadowmouse]

Thank you

[dhayden]

I'd avoid flow charts. They don't lend themselves to structured code very well. Pseudocode works great for me.

[shadowmouse]

It's just that my exam board really likes them for documenting algorithms.