home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
High Voltage Shareware
/
high1.zip
/
high1
/
DIR2
/
COBGEN.ZIP
/
INFO.DOC
< prev
next >
Wrap
Text File
|
1993-05-17
|
3KB
|
62 lines
COBGEN --
This program is designed to save you hours of work when developing small,
medium, or large scale OO projects in C++ It produces compile
ready header and object files. You can use this program to produce
these templates for you. If you are working as part of a team the use of
this product will ensure all your programmers follow the same basic structure
and format. If you choose to extend this method of documentation, it can
provide a solid foundation upon which to write your code.
COBGEN accepts two different command argument options:
-f Specification of the file from where your index of
relationships is. This is a two column file with the
first column specifying the filename by which to save
the class under. The second column is the actual name
of the class.
-p Specification of the optional file of what you want all
your c++ source files to contain at the top of them. This
would be where you would place any copyright information or
information of that nature, common to all source files.
The sample files included:
EXAMPLE.BAT -- Runs the example to show you what gets generated with
the given input specifications file.
HEADER.TXT -- A sample (-p) file. It will prepend each of the
generated files with the contents of this file.
SAMPLE.TXT -- A sample (-f) file. This contains the two column table
by which the files are generated from.
One of the nice features of using the two column index table file, is that
when you are finished, you can use that table as a form of documentation for
the source program. If you ever want to know in which file a given class
is defined, you only need look at the table.
The generated object files (.cpp) have embedded documentation in each
service. This provides a solid foundation upon which you code. You can
use the Key fields (such as //%Status) to do a global text search to see
which services are DONE or STUBed. This will work as long as you document
your service as you work on it. You should place your PDL between the
//BEGIN and //TERMINATE comments.
You can use the stub service as a template to paste in your object. This
will help ensure you follow the same format on all of your services.
Note: The header files are included with the <> method (in the generated
code). This lets you take advantage of the path method of including
files. If you keep your header files in the same directory as the
.cpp files, then be sure to add "." to your include path.
If you like this program, you are invited to register your copy of it. Send
a check or money order, Payable to Au Software for TWENTY-FIVE dollars
($25) to:
Au Software,
P. O. Box 96,
Anaheim, CA 92815-0096