We use Doxygen (
www.doxygen.org) to extract documentation from our
C/C++ code. This tool also works for Java code and uses documentation
block similar to Javadoc for function definitions (i.e. /** your comment here */).
Doxygen recognizes all Javadoc tags, HTML tags and includes many of its
own tags for documentation markup in comments. Are there any plans to
integrate support for Doxygen into SlickEdit similar to the support for
JavaDoc?
The reason I ask is the following. SlickEdit appears recognize that you are in a Javadoc comment region by noticing the /** opening. This does some helpful things
1) It enables auto-completion of javadoc tags and
2) It enables the HTML toolbar for some useful HTML shortcuts
However, this "context switch" can also be frustrating when trying to write
comments. First, in this comment context an * is added at the beginning
of each new line. Not a huge issue but significant for comment maintenance
as not all developers in our group are SlickEdit users. (Note to self: work harder
on SlickEdit evangelism) Second, when typing the comment the editor
performs some strange realignments/wrapping of lines that actually hinder
writing the comment. I would like to be able to control the format of the
comment myself not have the editor decide for me where the words should
go, the goal being readability for both programmers reading code and for
the generated documentation. Last, the auto-completion of tags is a
hindrance when using Doxygen as several Doxygen specific tags are
auto-completed to something completely different and incorrect by
the editor (ie. @par --> @param ).
I do not know the extent of the use of Doxygen throughout the community
and those involved with SlickEdit, but I am interested in hearing the views
of others and whether there are any plans for supporting Doxygen more
fully when using SlickEdit.
Thanks,
Paul W. Joireman