[Passwordsafe-devel] Code docu, parameter validation, CMyString

[Steffen R. <ste...@st...>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

a few question for which I couldn't find answers:

- - do you have any conventions for code documentation (e.g. descriptions
what methods do and what their parameters mean)? Possibly an approach,
that allows to generate HTML or similar out out comments strinkled over
the code..
If not, what about using doxygen (http://www.stack.nl/~dimitri/doxygen)?
It can generate HTML, PDF etc. from specially marked code comments,
comparable to javadoc. If haven't chosen such a tool yet, I will write a
 config file for doxygen


- - do you have any conventions/ a rule of thumb, where parameters should
be validated and where we trust they are correct?
I made some enhancements to the unit tests (not in svn yet) during the
weekend and asked myself whether it makes sense to add validations.
For instance, if you instantiate CXMLprefs with an empty or non-existent
file name, the first Load() call asserts. Is this worth fixing or do we
rely on parameter validation in higher-level classes?

- - Is it correct that CMyString is intended as a wrapper around MFC's
CString, in order to improve portability?
This confuses me a little bit, because CString is used so often in other
classes (I looked only into corelib).


Cheers,

Steffen
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFF9d9FCAP6QscD9IERAth2AKCoMZC3JriAAA9IfUbZx6kTrBzSvgCglWAm
8rxjvTb7SV44zDl6YbUHPGc=
=w0Rp
-----END PGP SIGNATURE-----