Re: Some issues with the codebase

[Federico Montesino Pouzols]

On Thu, Jan 09, 2003 at 03:26:45PM -0800, Chad Yates wrote:
> After writing this and then checking out the latest patches/changes, I
> discovered there is a Code style written up, it's in the texi documentation
> (I still haven't figured out how to view).
> 

        Does not a 'commoncpp2.info' file get generated when you run
make? .info files can be read with 'info' or alternate tools, such as
'pinfo'. There are many tools to process texi files, among them GNU
makeinfo, with which you can generate htmls and xmls (DocBook or
TexInfoML). There is also 'texi2dvi', and 'texi2pdf'.

        We have not put this manual online since it is somewhat
incomplete and some parts are outdated, though, if people want, we
could put it on the web, as with the reference manual.

> If you want to know what I typically use:
> 
> 1) Types: named like classes since they are in the same family and
>    represent an object/primitive of some sort.
> 2) Instances/Attributes/Variables: named like methods but more lax.
> 3) Constants: all UPPERCASE, PI, MAX_SIZE, enum {RED, GREEN, BLUE}
> 4) Methods: as above, typcially verb prefix + (processJob, addElement..)
> 5) Private: in the private section of the class declaration. no
>    distinction from other member variables (hey they may start public,
>    but then be moved to private or vice versa.
> 6) Global: ?? I don't use these except under extreme conditions. but I
>    would expect same as Methods and Member variables

        Well, it seems that we mostly agree that the current
recommendations in the manual, though not always followed in cc++ :),
are quite good. Please, forget my obnoxious recommendation regarding
leading underscores :).

> 
> > why not simple using comm ?? placeholder for common c++ or
> > communication :-)
> >
> > I think this is a very esotheric issue and so many different opinions
> > around ... so sorry for bugging you ;-)
> 
> It's really a can of worms isn't it. or maybe snakes. :)
> 
> Later!
> 
> chad
> 
> 
> 
> _______________________________________________
> Bug-commoncpp mailing list
> address@hidden
> http://mail.gnu.org/mailman/listinfo/bug-commoncpp