Filenaming conventions exist for most any type of file one would find it necessary to create when programming in our environment. In this document we will focus on the naming of:
- Naming of class and utility header files
- Naming of class method files
- Naming of utility files
- Naming of library files
- Documentation
-
Naming of class and utility header files
Header filenames for classes take the form:
classname.h or utilityname.h classname_constants.h or utilityname_constants.hWhere, classname is the same as the name of the class ignoring capitalization. For utility header files, classname is replaced by the name of the utility. "h" is the file extension we use for all header files - C or C++. Some more examples follow:Class = Float_8 Header = float_8.h float_8_constants.h Class = Fourier_Transform Header = fourier_transform.h fourier_transform_constants.h Utility = analyze_fft Header = analyze_fft.h analyze_fft_constants.h- Naming of class method files
Class method filenames are structured in the following manner:XXXX_YYYYYY_ZZ.ccThe rules for forming the filenames are:-
The total number of characters in method filename should not exceed
15 characters. This was initiated due to constraints in previous
versions of the SunOS.
-
XXXX indicates the class that this method is a member of.
So for the class "Channel", XXXX would be "ch".
-
YYYYYY indicates the type of method that the file contains.
For instance a method to set the value of a data member would have
YYYYYY equal to "set".
-
ZZ is the number of the method relative to the other methods
of that type. The index is left-padded by zeros up to two digits.
Thus, if there were three methods to set data members they would
have ZZ equal to 00, 01, and 02 respectively.
-
The "cc" extension is standard for all C++ files written at ISIP.
-
Constructors and Destructors should be of the form:
XXXX_cstr_0.cc where ZZ = 0 is reserved for
the destructor and ZZ = 1 is reserved for the
default constructor.
Method = Data_collect::init_cc Filename = dcol_init_0.cc Method = Channel::get_dtmf_cc Filename = ch_dtmf_1.cc- Naming of utility files
Utility files have the same naming convention as class method files with the exception of the main program. The main program file name follows the same basic conventions as the header files with the file extension being changed from "h" to "cc". This gives filenames of the following form:utilityname.cc Example: Utility = certify_fft Filename = certify_fft.cc- Naming of library files
Library files are of the form:
lib_libname.aHere, libname is determined by what is contained in the library. Here are some examples to clarify.Library = lib_isip.a Contains: standard ISIP classes Library = lib_linkon.a Contains: classes related to the Linkon project- Documentation
Naming of documentation files is mostly left up to the programmer. There are, however, two exceptions:
- The user's guide for the project must be written in Adobe
Framemaker and must be titled USERS_GUIDE.fm
- Each project must have a file named AAREADME.text in the
project root directory which gives a description of the project
as shown on this page.
- Naming of class method files
