visual c# express 2010 - XNA Class library -
seems simple task despite google , looking @ menus cannot find how @ documentation of classes or objects in xna.
in unity press ctrl , ' is in visual c#/xna? looking information on created classes/objects not online documentation/help.
you can search msdn required information. example, here link spritebatch class.
the msdn not limited xna, useful tool microsoft based languages.
please note of xna documentation not informative. i've come across pages on xna functionality contain 1 or 2 lines - no example code either!
what classes people have created , documented?
the author of code need provide documentation in code. here example:
/// <summary> /// example of xml documentation class. /// </summary> class program { /// <summary> /// example of xml documentation public method. /// </summary> /// <param name="name">the name validating.</param> /// <returns>true if valid, otherwise false.</returns> public bool isvalid(string name) { return true; } }
visual studio automatically generate of xml you. type "///" above class/method begin. can read more on here.
you able view code documentation hovering on class/function name.
Comments
Post a Comment