Я использую синтаксис тройной наклонной черты Doxygen для разметки мой код C++. Существует два важных случая, которые возникают:
1) комментарии разметки блока, которые являются единственным элементом на строке и могут или не могут начать выравнивание по левой границе; например.
class foo
/// A one sentence brief description of foo. The elaboration can
/// continue on for many lines.
{
...
};
void foo::bar
/// A one sentence brief description of bar. The elaboration can
/// continue on for many lines.
() const
{
...
}
2) запаздывающие комментарии разметки, которые всегда следуют за некоторым количеством маркеров C++ раньше первая строка, но могут все еще перетечь на последующие строки; например.
class foo
{
int _var1; ///< A brief description of _var1.
int _var2; ///< A brief description of _var2
///< requiring additional lines.
}
void foo::bar
( int arg1 ///< A brief description of arg1.
, int arg2 ///< A brief description of arg2
///< requiring additional lines.
) const
{
...
}
Интересно, что скрывается/показывает, поддержка существует для контакта с этими конвенциями. Самые важные случаи являются комментариями разметки блока. Идеально я хотел бы смочь устранить их в целом, подразумевая, что я предпочту не тратить впустую строку просто для указания на присутствие свернутого комментария разметки блока, предпочитая маркер края, а-ля hideshowvis.el.