Doxygen: doporučení pro komentáře

[Waseihou]

Je možné nějak v doxygenu nastavit, aby místo /** resp. /*! začínal složený komentář něčím jiným a končil taky. Potřebuji vytvořit dokumentaci pro velkou část kódu

Kód: [Vybrat]

.h:
//----------------------------------
// BLAH
// @param x lorem ipsum
//----------------------------------
void method(int x);

.c:
//----------------------------------
// BLAH
// @param x lorem ipsum
//----------------------------------
void XXX::method()
{
// beera beera
}

komenty bývají duplicitní a často k ničemu, rozumná programová dokumentace chybí

Jak to udělat nejlépe? Možná se pokusím prosadit/zavést neexistující pravidla pro komenty do naší coding guidance, co byste kdo doporučili?

[Reklama]

[Franta]

Napsal bych si skript, který převede tyhle divné komentáře na standardní (/** … */) a máš klid. Přijde mi to lepší, než nějak ohýbat Doxygen – Doxygen totiž není jediný program, který může chtít pracovat s komentáři (co třeba IDE?) a na problém bys narážel opakovaně.

[Waseihou]

Některé komentáře nemohou být přepsány kvůli dll hellu aby se nemuselo rekompilovat. Tento více jak 15 let starý software má několik stovek dll knihohoven, je provázán s Oracle databází a musí běžet nepřetržitě, výpadky jsou přijatelné maximálně v řádu minut. Rekompilace by znamenala nutnost znovu vše otestovat a nasazovat což by mohlo trvat i několik měsíců, jinak se testují jen dll moduly zrekompilované a ty na nich závislé. Možná to nějak přehnat přes pipu sedem jestli seženu pro Windows a pak to nějak předhodit do doxygenu, nevím. Mohu používat powershell.