llvm dev - Jan 2016 - Question about comment conventions

This is a pretty trivial question, but why are triple-slash comments
('///')
sometime used instead of double-slash comments ('//').  I'm sure
that there
is a good reason and a convention involved, but I do not know what it is.

 

Thanks, MartinO

 

-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20160114/a687f967/attachment.html>

On Thu, Jan 14, 2016 at 9:23 AM, Martin J. O'Riordan via llvm-dev <
llvm-dev at lists.llvm.org> wrote:
> This is a pretty trivial question, but why are triple-slash comments
(‘///’)
> sometime used instead of double-slash comments (‘//’).  I’m sure that
> there is a good reason and a convention involved, but I do not know what it
> is.
>
>
>
For doxygen -- http://llvm.org/doxygen/

Eli
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20160114/27583275/attachment.html>

Hi Martin,

I guess that this is for documentation purposes and has to do with 
Doxygen parsing things after ///.

Cheers,
  Roel

On 14/01/16 18:23, Martin J. O'Riordan via llvm-dev
wrote:
> This is a pretty trivial question, but why are triple-slash comments
> (‘///’) sometime used instead of double-slash comments (‘//’).  I’m sure
> that there is a good reason and a convention involved, but I do not know
> what it is.
>
> Thanks, MartinO
>
>
>
> _______________________________________________
> LLVM Developers mailing list
> llvm-dev at lists.llvm.org
> http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev
>

Hi,

On top of the other answer, here is the LLVM specific convention for formatting:
http://llvm.org/docs/CodingStandards.html#doxygen-use-in-documentation-comments

— 
Mehdi
> On Jan 14, 2016, at 9:23 AM, Martin J. O'Riordan via llvm-dev
<llvm-dev at lists.llvm.org> wrote:
> 
> This is a pretty trivial question, but why are triple-slash comments
(‘///’) sometime used instead of double-slash comments (‘//’).  I’m sure that
there is a good reason and a convention involved, but I do not know what it is.
>  
> Thanks, MartinO
>  
> _______________________________________________
> LLVM Developers mailing list
> llvm-dev at lists.llvm.org <mailto:llvm-dev at lists.llvm.org>
> http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev
<http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev>
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20160114/eb3742e6/attachment.html>

Ahh, thanks.  That makes sense - I’d forgotten about the Doxygen connection.

 

            MartinO

 

From: Eli Bendersky [mailto:eliben at google.com] 
Sent: 14 January 2016 17:27
To: Martin.ORiordan at movidius.com
Cc: LLVM Developers <llvm-dev at lists.llvm.org>
Subject: Re: [llvm-dev] Question about comment conventions

 

 

 

On Thu, Jan 14, 2016 at 9:23 AM, Martin J. O'Riordan via llvm-dev
<llvm-dev at lists.llvm.org <mailto:llvm-dev at lists.llvm.org> >
wrote:

This is a pretty trivial question, but why are triple-slash comments (‘///’)
sometime used instead of double-slash comments (‘//’).  I’m sure that there is a
good reason and a convention involved, but I do not know what it is.

 

 

For doxygen -- http://llvm.org/doxygen/

 

Eli

 

 

-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20160114/4ea04f67/attachment.html>