- #DOXYGEN COMMENT EXAMPLES GENERATOR#
- #DOXYGEN COMMENT EXAMPLES CODE#
Doxygen generally assumes that that a comment block refers to the code. Use Doxygen primarily to clearly define the interface for others to use your code. Do include normal (non-Doxygen) comments to describe algorithms, approaches, etc within your code. To indicate a Doxygen comment block, add an "!" or "*" character to the openingĬomment character sequence. c file should include Doxygen comments (since they are not likely found in the. Don't duplicate the function comments in the source (.c) files where these functions are defined. Public functions should have Doxygen commenting in the. h) should include a Doxygen header block (template below). Objective-C, C#, PHP, Java, Python, IDL (Corba and Microsoft flavors),įortran, VHDL, Tcl, and to some extent D." Standard tool for generating documentation from annotated C++ sources,īut it also supports other popular programming languages such as C, If we change bool to boolean, and rename one_flip to oneFlip… we have a Java function.Supplemental Web Site: Use Brightspace for assignments, deadlines, other course information, and assignment submissionĮCE 486 Code Commenting Requirements (ALL labs) OverviewĪll C code submitted for ECE 486 should be commented to support the use ofĭocumentation directly from the source code. 
Both p and the possible return values are documented.
* true if the result is heads and false if the result is tails Which one do I get for heads? Let us add an /** Now what about the return? We know that bool means a true or false. What does p represent? Does it represent the probability of heads or tails? /** The one_flip function needs a description.
Seed the random number generator with the current time Suppose we have just finished writing a quick program to simulate a trick coin (i.e., a coin where heads and tails are not equally probable).
We revised the description for brevity and clarity.Īny time a function has a parameter it should be documented. We documented the input into the constructor (i.e., the parameter r) with an tag. * Create a Cookbook with a set recipe limit. The description should probably be cleaned up a little. * r max number of recipes that can be stored. What does r represent? Let us start by adding r to the documentation /** * outs output destination (e.g., cout or a file) * Display the Cookbook with each recipe separator by `\n-\n`. * true if both `this` should be listed before `rhs`īool operator<(const Cookbook& rhs) const * recipes then compare each pair of recipes, basing lhs < rhs on the * - If lhs and rhs have the same number of recipes, sort each set of 
* - If lhs has fewer recipes than rhs, lhs < rhs. * true if both this and rhs are Cookbooks with the same recipesīool operator=(const Cookbook& rhs) const * Compare two cookbooks based on the recipes they contain, ignoring the Void removeRecipe(const Recipe& to_remove) * part of this cookbook, this method becomes a no-op (it completes * `to_remove` is present in the cookbook.
* to_remove recipe to remove from the cookbook * Create a Cookbook that can contain at most _r_ * Create a Cookbook that can contain at most MAX_RECIPES
0 kommentar(er)
