Re: Audit

From:

Richard Herring <junk@[127.0.0.1]>

Newsgroups:

comp.lang.c++

Date:

Tue, 7 Jul 2009 16:16:41 +0100

Message-ID:

<ssCTGNQZb2UKFw1P@baesystems.com>

In message
<fe63b3c3-2c69-4f66-a929-4c389e34b577@k1g2000yqf.googlegroups.com>,
Jonathan Lee <chorus@shaw.ca> writes

Hello all,
To be a good little coder I want to ensure all of my functions pass
a checklist of "robustness". To keep things simple, I want to document
each function with a string that will indicate which of the checklist
items the function has been audited for. Something like

abcdefghiJklMnopqRsTuvwxyz

which would show that items J, M, R, and T have been checked. Off the
top of my head I came up with the list below. I wonder if anyone has
items they think should be added to the list. Any advice welcome,

--Jonathan

Audit list (an implicit "where applicable" should be assumed)
A - Arguments checked against domain
B - Arrays have bounded access
C - No C style casts, other casts as appropriate. Avoid
reinterpret_cast<>
D - No #define's - use static const, enum, or function
E - Exception safe
F - Floating point comparisons are safe (eg., don't check against 0.0)

There's nothing intrinsically "unsafe" about comparing floating-point
values with 0.0, if that's what your algorithm requires. What's unsafe
is programming floating-point arithmetic if you don't understand the
floating-point data model or the algorithm.

I - Use initialization lists in constructors
L - Loops always terminate
M - Const qualify member functions that need it
N - "new" memory is not leaked, esp., in light of exceptions
O - Integer overflow
P - Wrap non-portable code in "#if"s and warn user with #else
R - Reentrant
Q - Const Qualify object arguments
T - Thread safe
V - Virtual destructor

In a _function_?

--
Richard Herring