Unity Tip for Mono Develop – How to Comment your Functions & Parameters (with XML)

by Josh | Posted in Game Development & 3D | Tagged:

The way in which I was writing comments for my functions was consistent, but entirely in my own style. I knew there must be a better way of creating this documentation using a more standard coding convention. Indeed there is.

Using triple slashes and the format for XML comments, your explanation will be viewable when you using that function, through a tooltip. Those familiar with Visual Studio know this auto-completing feature as IntelliSense. Which parameter is displayed is dependent on where your cursor is located within the function call, as shown in the screenshot below:

Unity Tip - Parameter Comments with XML

 XML Comment Format

Here is a basic example of the code, for your copy-pasting. You could use only one of the following XML tags if you wanted. There are other recommended tags available too, such as remarks and para. Another great thing about using this format, is that there are tools available to generate documentation based upon it.

More Info

Recommended Books For Web Devs

CSS Secrets [Book Cover] Building out a design into HTML and CSS is like a series of small puzzles— some trickier than others. CSS Secrets: Better Solutions to Everyday Web Design Problems is a practical and modular look at many of the unique challenges you'll encounter during front-end development. Well-designed, and easy to pick up for any intermediate to advanced front-end dev looking to pick up some tips and tricks, and honing the processes used to figure them out.

Eloquent JavaScript [Book Cover] Eloquent JavaScript: A Modern Introduction to Programming is an engaging and well-formatted overview of JavaScript, complete with example projects and helpful diagrams. It's easy to read—not too dense, with readable type—and covers many subjects. The revised edition covers some of the newer features of JavaScript, including: class notation, arrow functions, iterators, async functions, template strings, and block scope.

The Phoenix Project [Book Cover] While The Phoenix Project: A Novel about IT, DevOps, and Helping Your Business Win is a fictional novel, the slightly exaggerated characters and situations involved will be very familiar to anyone working in software development and IT. In it, an IT manager is confronted with the seemingly impossible task of turning around a project that's over-budget and past deadlines in 90 days, or else his department will be outsourced. The morals and takeaways from this story about DevOps and lean principles will stick with you.

Leave a Reply

You can use the <pre> tag to post a block of code, or <code> to highlight code within text.