Home/ Questions/Q 6815537
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-26T20:49:10+00:00

Is there any recommendations for how to show what your code is doing (C

  • 0

Is there any recommendations for how to show what your code is doing (C or MATLAB)? Imagine if your code is really long and you have a lot of functions in your program, what is the best way to document the program? I know Java IDEs have a way to ingest comments and spit them back out into a document that shows all the functions, and their inputs and outputs. I don’t think C or MATLAB has this feature. At this point, I am thinking comments are the only way to show what is going on in the code, but it may confuse the reader if they have to look through the raw code along side the comments. The second option would be to write out the algorithm in a text editor such as Microsoft Word. Is there an industry standard for doing this?

Thanks!

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    What Java uses is JavaDoc.

    For C, you can use Doxygen.

    I also saw this which suggests you can use Doxygen with matlab too!

    • 0