[Doxygen-users] RE: [Large] Algorithmics comments or comments inside body functio ns.
Brought to you by:
dimitri
|
From: Putman, H. <Pu...@di...> - 2001-09-25 20:40:37
|
I like the idea of commenting in the function body.
I actually tried putting 'special' comments in my function bodies hoping they would become part of the detailed description for the function. I think that would be logical. I think it would be most natural to add any indentation by hand using HTML tags. This would save having to learn a new set of tags for body comments.
void funcion(void)
# {
# int i;
#
# /// Increment the global variable a
#
# a++;
#
# /// Printing the message
# /// the message is "Sayonara baby"
#
# PrintMessage("Sayonara baby");
#
# // It can be normal comments
#
# /// For all componets in the array
# for(i=0;i<a;i++)
# { /// <ul>
# /// <li> print the component message
# ArrayComponet[i].PrintMessage();
#
# /// <li> For all component lines
# while(ArrayComponent[i].NumLines())
# { /// <ul>
# /// <li> Get the line
# CLine a=ArrayComponent[i].GetLine()
# /// <li> Printing
# a.Print();
# /// <li> Deleting
# a.Delete();
# } /// </ul>
# }// </ul>
#
# /// Deleting the Array
# ArrayComponent.Delete();
#
# }
The configuration file could control whether these body comments were extracted since you might not want that included in your public documentation.
@return Cheers
Harold Putman
|