Re: [boost] Re: Review: Boost Coding Guidelines

From: John Max Skaller (skaller_at_[hidden])
Date: 2001-07-18 15:14:52

jeff_at_[hidden] wrote:

> As previously mentioned by someone
> else, the key reason for formatting requirements is consistency amongst a
> development team, and so this is certainly less of an issue for boost except
> during library review. 

Human readability isn't the only issue. Compilers ignore comments
and formatting style. Compilers aren't the only useful tools.
Documentation extraction tools are also useful, and they
require different standards to operate correctly, such as
assuming which comments are associated with which entities.

If boost users want to be able to extract interface documentation
from source, then boost needs rules -- not guidelines --
about things like comment placement.

-- 
John (Max) Skaller, mailto:skaller_at_[hidden] 
10/1 Toxteth Rd Glebe NSW 2037 Australia voice: 61-2-9660-0850
New generation programming language Felix  http://felix.sourceforge.net
Literate Programming tool Interscript     
http://Interscript.sourceforge.net