Tom Ring wrote:
...
our code (my "code" is probably 80% comments) and don't declare
(assuming they declare at all) our functions as void. Unless they
...
tom
K0TAR
I certainly would not go about bragging in that style, dead sign of lack
of structure/logic in the code leading to obfuscation and requiring
extraordinary effort of documentation ...
The comments in source are only meant for other programmers, they
already know how to program, you don't have to teach 'em, nor attempt to
impress them with your brilliance--if such is present--they'll know.
With the proper use of significant names for variables, structs,
defines, etc. and programming for a "logical flow" of code, few comments
are needed (approx. 10-20% comments should be more than sufficient--if
the source is structured and non-obfuscated.)
Krist, they pay me to engineer software, not write books ... (if
management had their way--they'd screw that up ...)
SIMPLIFIED EXAMPLE:
// call at any point to debug/check variables
(void) debug_printout_of_variables_used(float whip_self-capacitance_pf,
float coil_self-capacitance_pf,
float coil_inductance_uh,
...)
{
cout "Whip self capacitance (pf): " whip_self-capacitance_pf
endl;
cout ...
...
}
JS