Re: [Boost-docs] [quickbook] Comments

Subject: Re: [Boost-docs] [quickbook] Comments
From: Paul A Bristow (pbristow_at_[hidden])
Date: 2007-07-30 08:34:19

>-----Original Message-----
>From: boost-docs-bounces_at_[hidden] 
>[mailto:boost-docs-bounces_at_[hidden]] On Behalf Of Joel de Guzman
>Sent: 30 July 2007 01:57
>To: Discussion of Boost Documentation
>Subject: Re: [Boost-docs] [quickbook] Comments
>
>Jake Voytko wrote:
>> On 7/29/07, Joel de Guzman <joel_at_[hidden]> wrote:
>>> Another idea might be to use another syntax. Example:
>>>
>>>      [// this is a comment //]
>>>
>> 
>> For what it's worth, how about C++-style multi-line comments?
>> 
>> [/* Commenting out this section as a test
>> 
>> [section:comment_out Commented out]
>>   ....
>> [endsect]
>> 
>> */]
>> 
>> It's a little extra typing, but it should be immediately obvious to
>> the Boost crowd
>
>I'm sure the Boost crowd, as smart as they are, will have no problems
>with any syntax we throw in ;-) Compared to the complexities of c++
>template syntax, this is, ehm, peanuts :-P

:-))

Another reason why */ might be less good is that one might want to include a /* */ C comment within a Quickbook comment - and it
would be prematurely terminated.

Paul

---
Paul A Bristow
Prizet Farmhouse, Kendal, Cumbria UK LA8 8AB
[phone] & SMS, Mobile [phone] & SMS
pbristow_at_[hidden]