warning CS1591: Missing XML comment for publicly visible type or membe

[needscoop]

I've enabled documentation for a C# project, but now when I compile I get scores of the "warning CS1591: Missing XML comment for publicly visible type or member ..." warnings!

I'm putting /// <summary> and ///</summary> stmts within the method (with /// comments sandwiched in between the summary tag stmts), but still get the warnings.

Any insights would be helpful.

 

[needscoop]

figured it out...
appears the comments must precede the method
(rather than being placed within the method).

 this example is okay:
		/// <summary>
		/// MyMethod:  sorts the MyTable data.
		/// </summary>
		public void MyMethod()

 this example gives the CS1591 warning:
		public void MyMethod()
                {
                    /// <summary>
                    /// MyMethod:  sorts the MyTable data.
                    /// </summary>
                    string a = "whatever"
                }

 

[chiph]

If you're using Visual Studio, just go to the line before the method, and type ///, and VS will fill in a lot of the XML Comment for you.

Chip H.


____________________________________________________________________
If you want to get the best response to a question, please read FAQ222-2244 first