Re: Audit

From:

Victor Bazarov <v.Abazarov@comAcast.net>

Newsgroups:

comp.lang.c++

Date:

Tue, 07 Jul 2009 10:52:32 -0400

Message-ID:

<h2vnd5$quh$1@news.datemas.de>

Jonathan Lee wrote:

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)
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

How are 'D', 'V', applicable to a function? Are you going to make all
d-tors virtual? That's an overkill. 'D' is module-centric, not
function-centric.

E - add "multiple-return-statement safe", IOW, use RAII; but that
probably goes without saying.

F - Comparison of floats to 0.0 is OK in some circumstances.

Q - not always necessary or feasible.

T - sounds good. What does it mean?

V
--
Please remove capital 'A's when replying by e-mail
I do not respond to top-posted replies, please don't ask