INTERNET APPLICATION DEVELOPMENT
MID MARKET ERP DEVELOPMENT
This is a continuation from a previous blog.
When creating documentation, you can use a reference in some types of tags. The compiler translates the reference for you. For example:
It will convert the simple method name to the full method name:
If the reference is invalid, for example, you don’t have a method called sayBye(), it won’t stop your program from compiling. But, you will see a green wavy line under the method name.
And, an “!” in front of the method name.
When a person other than the developer is responsible for creating documentation for the project, plus the comments are taking up large space in the code, it could be inconvenient for both the developer and documenter. In this case, you can use <include> like this:
Here are more recommended tags.
To convert the XML comments into full formatted help files, you can try Sandcastle.