4

In Netbeans, if I place comments above all my methods:

Example method with comment

and then right click on my project and click generate Javadoc:

Context menu: Generate Javadoc

What gets generated is an HTML document containing the API with the method comments:

"Method Detail", showing the method name and its comment

This is really useful when working in an agile environment where transparency is so appreciated.


I know that in MySQL you can place comments in a similar fashion, for tables:

Entering comment for a MySQL table

For stored procedures:

Comment for a stored procedure

and for all other database components.

My question is, is there software that is compatible with Windows 7 that can do what Netbeans does to a Java application except to a MySQL database?

6
  • 2
    I never tried it with MySQL: HyperSQL was written for Oracle, but might be worth a try.
    – Izzy
    Nov 6, 2014 at 21:11
  • @Izzy: This should be an answer, surely?
    – anon
    Nov 7, 2014 at 11:59
  • Being written for Oracle (and I've tested it only with that), I was not sure whether it meets your requirements. If you confirm it's an acceptable solution for you and works with your MySQL code, I happily make it an answer!
    – Izzy
    Nov 7, 2014 at 13:04
  • @Izzy: Do you know if it works with windows 7?
    – anon
    Nov 7, 2014 at 13:47
  • It requires Python, which is available cross-platform. I've been using it on miscellaneous Linux machines (SuSE, Ubuntu), but never on Windows – though I see no specific reason why it shouldn't work there. As it's free (and even open-source), why not simply give it a try? It's setup is as easy as unpacking it and changing into its directory, with some optional adjustments to the .ini file.
    – Izzy
    Nov 7, 2014 at 13:52

1 Answer 1

1

sqlDoxygen

Doxygen is a well-known standard tool for creating source code documentation. Unfortunately, it does not natively support SQL. sqlDoxygen is a branch of doxygen with SQL parsing added.

Features:

  • Converts comments into HTML, XML, or LaTeX documentation for the source code
  • Supports HTML, Markdown, and other special commands in the comments
  • Has detailed documentation

I've only used it with C++ and Fortran, but I assume that it should generate similar results in SQL. The repository also has a couple test files that show which format should be used.

5
  • Do you know how one can install sqlDoxygen? I downloaded doxygen for win32 and installed it but I got no idea how to add sqlDoxygen to it?
    – anon
    Nov 7, 2014 at 13:43
  • @ThreaT I think you could clone the repository git clone [email protected]:paulpster/sqlDoxygen.git, then use the winbuild folder to build the source. I will try it later today and update the answer with instructions
    – Tymric
    Nov 7, 2014 at 13:55
  • It's not immediately clear - is this connecting to a MySql database and generating output from there? Or is it scanning source code which manipulates a database?
    – Mawg
    Feb 6, 2015 at 14:16
  • 1
    @Mawg Doxygen scans the source code for documentation blocks. It's easier to start with the manual of the original Doxygen. Example files for sqlDoxygen are found in the examples folder. Otherwise, it should work the same way as Doxygen does
    – Tymric
    Mar 8, 2015 at 12:45
  • @Threat did you ever try this? did you get an answer?
    – Mawg
    Dec 17, 2018 at 13:10

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.