FeinSoftware presents CommentMakerPro - comment generation tool designed to work in Visual C++ under current versions of Microsoft Visual Studio .NET (7.0 and 7.1).
Every developer understands the need of properly documenting their code, but not all of us do it. Common reasons are "not enough time", "too many other things to do", etc.
CommentMakerPro does some of the work for you. It creates customizable class, function and file comment blocks that you can adjust to most companies' documentation requirements. For example, default settings of CommentMakerPro create comments that are compatible with a popular document generation tool Doxygen, which is used by many software companies.
There are many tools on the market similar to CommentMakerPro, but all of them have some shortcomings. Most trivial simply paste a boilerplate for function header that must be edited according to number of function parameters, return type, etc. Some are not compatible with Visual Studio .NET, other are simple text parsers that play a role of a C++ compiler to determine function's type, parameters, and parameters' type (often incorrectly). The main difference of FeinSoftware's CommentMakerPro from its competitors is utilization of Visual Studio for the code analysis. The comments generated by CommentMakerPro correctly list formal parameters of the function with their types, constness and optional default values. For the function itself, CommentMakerPro states its access type (public, protected or private), whether it is virtual, constant, overloaded, constructor / destructor or operator.
CommentMakerPro is template-based, so it is fully customizable. It allows you to choose what information will be included in the generated comment: parameters, return type, remarks, reference, author and date, and to specify meta commands to use for each element. This provides easy tuning to document generation tool of your choice, or simply to you company's standard.
» version 1.2 - posted on 2004-08-08
Function comments could be inserted at either definition or declaration of that function. Class comments are supported.
One-click comment generation for entire file or entire project.
EULA - End User License Agreement
CommentMakerPro? End User License Agreement
This End-User License Agreement (EULA) is a legal agreement between you (either an individual or a single entity) and the author of this software FeinSoftware (AUTHOR) for the software product CommentMakerPro?, which includes computer software and may include "online" or electronic documentation (SOFTWARE). By installing, copying, or otherwise using the SOFTWARE, you agree to be bound by the terms of this EULA. If you do not agree to the terms of this EULA, do not install or use the SOFTWARE.
1. GRANT OF LICENSE.
Evaluation Copy. If you acquired the license for the SOFTWARE on an evaluation or trial basis, you may use the SOFTWARE without charge for thirty (30) days from the day that you install the SOFTWARE. You must pay the license fee and register your copy to continue to use the SOFTWARE after the thirty (30) day evaluation period. When payment is received you will be sent your own registration code.
Registered Copy. You must purchase a license for each separate computer on which the SOFTWARE is used. A license for the SOFTWARE may not be shared by alternating use of the SOFTWARE between different computers. The primary user of a computer for which a license has been purchased may install and use one copy of the SOFTWARE on his or her portable computer. You may also make a copy of the SOFTWARE for back-up or archival purposes. Otherwise, you may not copy the SOFTWARE in whole or in part. You may permanently transfer all of your rights under this license provided you transfer all copies of the SOFTWARE and the recipient agrees to the terms of this license.
2. SCOPE OF GRANT
You may not decompile, disassemble or otherwise reverse engineer the SOFTWARE, or engage in any other activities to obtain underlying information that is not visible to the user in connection with normal use of the SOFTWARE. You may not modify, rent, or resell for profit this SOFTWARE, or create derivative works based upon this SOFTWARE. You may not publicize or distribute any registration code algorithms, information, or registration codes used by this SOFTWARE without permission from the AUTHOR.
This SOFTWARE is protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties.
Only the evaluation version of this SOFTWARE may be freely distributed.
Provided that you verify that you are distributing the evaluation version, you may distribute this SOFTWARE on on-line services, bulletin boards, or other electronic media provided that it is not modified and the original archive remains intact with all accompanying files, and provided that no fee is charged. This SOFTWARE may not be distributed on CD-ROM or other physical media for a fee without the permission of the AUTHOR.
The license will terminate automatically and the SOFTWARE unregistered if you fail to comply with any of the above terms and conditions.
6. DISCLAIMER OF WARRANTY
This software is provided AS IS without warranty of any kind. The entire risk arising out of the use or performance of the product remains with recipient. To the maximum extent permitted by applicable law, in no event shall the author be liable for any consequential, incidental, direct, indirect, special, punitive, or other damages.