Home > Back-end >  How to document a method and specify its return type in WPF
How to document a method and specify its return type in WPF

Time:11-11

How could I specify to the intellij the return type of a method?

/// <summary>
/// A method that returns a list of strings.
/// </summary>
/// <returns>List<String></returns>
private List<string> GetListOfStrings(){
   // Code...
   return list;
}

Notice that List is read just like a List in the intellij, how could I specify that's a list of strings?

Also, is there any site or tip/advice you can gimme about how to document in WPF?

CodePudding user response:

<see cref="List{T}" /> may work.

Reference for C# documentation comments. It's available not only for WPF.

If you are looking for a good practices in XML documentation comments and good coding practices I'd suggest looking into a source code of a well-known libraries and frameworks.

For example ASP.NET Core source code or WPF itself

  • Related