getting the tip message for method during design time
-
When typing in the method during writing the code, I noticed that Visual Studio display the description of the method on what it does. I know I found info somewhere in the past but can't find it! How do I do that on my code so it would be easier for other developer to know what these methods are for. It'll be useful for the method overloading. For example, when you type as follows: MessageBox.Show( you'll get the message saying from the tip as follows: 1 of 21 DialogResult MessageBox.Show (string text) text: The text to display in the message box.
-
When typing in the method during writing the code, I noticed that Visual Studio display the description of the method on what it does. I know I found info somewhere in the past but can't find it! How do I do that on my code so it would be easier for other developer to know what these methods are for. It'll be useful for the method overloading. For example, when you type as follows: MessageBox.Show( you'll get the message saying from the tip as follows: 1 of 21 DialogResult MessageBox.Show (string text) text: The text to display in the message box.
-
type '///' before the method and it will autotype a summary i.e.
///<summary>
/// this method does stuff
/// <param name="s">string for s</param>
/// <summary>
void DoStuff(string s)
{}
THANKS! That's the answer I wanted! That's even better than the info I found in the past (manually doing the tips via xml). Now I see why the sample codes elsewhere use /// stuff. I had no idea why coders use 3 slashes. THANKS A HEAP! That's a new lesson I've learned today.
-
THANKS! That's the answer I wanted! That's even better than the info I found in the past (manually doing the tips via xml). Now I see why the sample codes elsewhere use /// stuff. I had no idea why coders use 3 slashes. THANKS A HEAP! That's a new lesson I've learned today.
-
THANKS! That's the answer I wanted! That's even better than the info I found in the past (manually doing the tips via xml). Now I see why the sample codes elsewhere use /// stuff. I had no idea why coders use 3 slashes. THANKS A HEAP! That's a new lesson I've learned today.
// Is standard single line comment /// is standard single line xml comments /* * Is standard multiple line comments */ /** * Is multiple line xml comments */
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
If you don't ask questions the answers won't stand in your way.
Most of this sig is for Google, not ego. -
THANKS! That's the answer I wanted! That's even better than the info I found in the past (manually doing the tips via xml). Now I see why the sample codes elsewhere use /// stuff. I had no idea why coders use 3 slashes. THANKS A HEAP! That's a new lesson I've learned today.
It also gets used to provide the documentation you see in CHM files. If you have this before a method, choose the documentation options in your project you can produce a documentation file that you can use to create a help file from (using a utility like Sandcastle).
"WPF has many lovers. It's a veritable porn star!" - Josh Smith
-
// Is standard single line comment /// is standard single line xml comments /* * Is standard multiple line comments */ /** * Is multiple line xml comments */
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
If you don't ask questions the answers won't stand in your way.
Most of this sig is for Google, not ego.// Is a lazy-a$$ comment, only weak developers use it /// Is a lazy-a$$ XML comment, only weak developers use it /* * Is a proper comment */ /** * Is a proper XML comment */
-
It also gets used to provide the documentation you see in CHM files. If you have this before a method, choose the documentation options in your project you can produce a documentation file that you can use to create a help file from (using a utility like Sandcastle).
"WPF has many lovers. It's a veritable porn star!" - Josh Smith
Cool - I didn't know that. Nice tip Pete :beer:
Dave
BTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)
Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia) -
It also gets used to provide the documentation you see in CHM files. If you have this before a method, choose the documentation options in your project you can produce a documentation file that you can use to create a help file from (using a utility like Sandcastle).
"WPF has many lovers. It's a veritable porn star!" - Josh Smith