Editing Continuing doxygen comments

{{review}}
{{TipImported
|id=653
|previous=652
|next=654
|created=February 10, 2004
|complexity=intermediate
|author=Michael Brailsford
|version=6.0
|rating=6/6
|category1=C++
|category2=Options
}}
This will continue lines of <tt>///</tt> [http://www.doxygen.org doxygen] comments when you reach the end of a line while typing a comment. It also works if you use <tt>o</tt> to open a new line while on a comment starting with <tt>///</tt>. It only works if there is a space between the last <tt>/</tt> and the first letter of the comment, that is no big deal, since it lends itself to readability. So for example:

<pre>
/// This will work.
///This won't.
</pre>

Here is the magic line. Make sure you put it somewhere that will get sourced whenever you open a file you want to use with doxygen. I have it in ~/.vim/after/ftplugin/c/c.vim, so it gets sourced for all C and C++ files.

<pre>
set comments=sO:*\ -,mO:*\ \ ,exO:*/,s1:/*,mb:*,ex:*/,bO:///,O://
</pre>

All other comments will continue to work as expected.

==References==
*{{help|'comments'}}
*{{help|format-comments}}

==Comments==
I use:

<pre>
set comments-=://
set comments+=:///,://
</pre>

True, it puts them at the end of the comment expression list, but I don't think that will be a problem. This way, I don't have to worry about any other comment expressions that may be present.

Keep in mind that loading a new syntax file overwrites whatever you have set "comments" to be.
Add this to your vimrc if you don't want to keep retyping "set comments..."

<pre>
autocmd FileType c,cpp set comments-=://
autocmd FileType c,cpp set comments+=://!
autocmd FileType c,cpp set comments+=://
</pre>

----

I think, for the .vimrc, the post just above should read:

<pre>
autocmd FileType c,cpp set comments-=://
autocmd FileType c,cpp set comments+=:///
autocmd FileType c,cpp set comments+=://
</pre>

That's what worked for me. - Chris B

----

Or just use ^= instead of += to prepend the new option:

<pre>
autocmd Filetype c,cpp set comments^=:///
</pre>