This tool goes through all files of the current solution and looks for class, function and macronames. Really nothing special but it can be useful sometimes. For better accessibility it also is on the right click menu of the code editor. This is something a simple macro could also do: it swaps between header and code files. The difference to my old tool is that it now generates graphs for all projects in the solution and puts all the graphs in one single html page. These two commands build graphs of the class relations in your solution. Since I haven't found a way to add a file directly to a solution and not to a project the file is just opened for view in the IDE. The generated html file with the counted lines (code, comments, empty) is then opened in the IDE. It counts all the lines of all files in your solution, grouped by projects. Under the line '\version' I usually insert short descriptions of what changed between versions. The last few tags should be self-explanatory. If you don't want to change the class comments for all your projects then you can place that files into your project directory (that way it will be used for your project) or inside the folder of your source files (that way it will be used only for the files inside that specific folder). You can customize the class comments by editing the file "classheader.txt" Please read the comments inside that file on how to do that. Maybe you want to change that too to include an email address. The name after the '\author' tag is the currently logged in user. It's not necessary for Doxygen, but I found it very useful to give that information inside a class documentation. The '\par requirements' section you have to modify yourself to fit the truth of your class. For more helpful tags you can use please check out the Doxygen website. If you want to include pictures to illustrate the class, use '\image html "picture.jpg"'. Insert the description of the class right after that statement. That statement helps Doxygen to group classes together. The '\ingroup projectname' means that the class is inside the project 'projectname'. * fall ill, increases baldness or makes your car start emitting strange * liability if it causes any damage to your computer, causes your pet to * "as is" with no expressed or implied warranty. * This code is absolutely free to use and modify. * win98 or later, win2k or later, win95 with IE4 or later, winNT4 with IE4 The inserted comment for a method or function would look like this: Just place the caret over a method or class header. Either from the right click menu in the code editor window or from the submenu under Tools->Kings Tools. This part of the tools inserts them for you. Insert Doxygen commentsÄoxygen needs comments that follow certain conventions to build documentation from. TODO: find a way to integrate the generated windows help file into VS help. If you want to update Doxygen to a newer version (as soon as one is released) simply overwrite the doxygen.exe in the installation directory. To do that the KingsTools add a command to the right click menu in the solution explorer. If you don't want that for example if you have several third party projects in your solution then you can build the documentation also for single projects. The command available from the Tools menu builds the documentation for the whole solution. A winhelp output ( index.chm) will be opened outside the IDE. If you set Doxygen to generate html output, the resulting index.html is opened inside the IDE. All settings in that file override the settings you enter in the dialog box. Since the dialog box doesn't offer all possible settings for doxygen, you can always edit the file Doxyfile.cfg manually which is created the first time you run it. It can produce documentation in different formats like html and even windows help format! See for details. For those who don't know Doxygen: it's a free tool to generate source documentations. This command first pops up a dialog box in which you can configure the output Doxygen should produce. Sure, most of the functions in my Tools could also be done with macros, but I wanted them all packed together with an installer. But MS knew that they couldn't fulfill every wish so they provided a way to write addins. NET is, I still miss some features in it.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |