Dokumentiranje

Vse o programiranju na in za PC

Moderatorji: Kroko, tilz0R

Dokumentiranje

OdgovorNapisal/-a s54mtb » 18 Jun 2018, 15:50

Običajno v bloku komentarja pred funkcijo uporabim sintakso tagov za doxygen:

@brief
@detail
@param
@retval

itd...

ali obstaja kaj za eksplicitno izpostaviti, da funkcija spreminja npr. neko globalno spremenljivko? Recimo @sideeffects oz. nekaj podobnega ?
Namesto "Zahvali se" sprejemam tudi šalco kofeta: https://www.buymeacoffee.com/s54mtb
Uporabniški avatar
s54mtb
 
Prispevkov: 11208
Pridružen: 15 Jan 2015, 01:10
Zahvalil se je: 1559 krat
Prejel zahvalo: 4068 krat
Uporabnika povabil: Vrtni palček
Število neizkoriščenih povabil: 255

Re: Dokumentiranje

OdgovorNapisal/-a tilz0R » 18 Jun 2018, 18:39

Direktno ne, lahko pa uporabiš \note ali \warning, kjer omeniš, da lahko ta funkcija počne neumnosti. Potem se to v dokumentaciji obarva z rdečo ali rumeno (mogoče modro?), kjer userju takoj pade v oči da mora biti pozoren.

Pri moji dokumentaciji je note rumen, je pa res, da sem predelal osnovno temo doxygen-a.
http://majerle.eu/documentation/esp_at/ ... o_n_f.html
Knowledge sharing is people' caring., T. MAJERLE
Uporabniški avatar
tilz0R
 
Prispevkov: 1819
Pridružen: 18 Jan 2015, 00:12
Kraj: Črnomelj
Zahvalil se je: 229 krat
Prejel zahvalo: 511 krat
Uporabnika povabil: s56rga
Število neizkoriščenih povabil: 255


Vrni se na Programski jeziki

Kdo je na strani

Po forumu brska: 0 registriranih uporabnikov in 1 gost