Add Description to Method's parameters

Question

Hi,

I have this method:

public static string Encrypt(string text, string key)  

How can I create a description for the two parameters so user will be able to see in VS when using this method?

Thanks,
Jassim

Answer 1

@Jassim Al Rahma . thanks for the feedback, based on my test, I reproduced your problem.

I find that we need to do some special settings when we use c# documentation in other projects.

First, We could edit your TempMAUIClass.csproj to add the following tag in your propertygroup:

<PropertyGroup>  
  
                  <GenerateDocumentationFile>true</GenerateDocumentationFile>-> add it  
</PropertyGroup>  

Second, Please rebuild your project and check if you have the xml file in your output folder.

Third, Please Repeat steps one and two above for your project TempMAUIAppUsingClass.

Finally, you could see the comment in the TempMAUIAppUsingClass project:

Best Regards,
Jack

---

If the answer is the right solution, please click "Accept Answer" and upvote it.If you have extra questions about this answer, please click "Comment".
Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.

Answer 2

Add xml documentation

public class Utilities  
{  
    /// <summary>  
    /// TODO  
    /// </summary>  
    /// <param name="text">TODO</param>  
    /// <param name="key">TODO</param>  
    /// <returns>TODO</returns>  
    public static string Encrypt(string text, string key)  
    {  
        ...  
    }  
}  

See Usage

Code

Answer 3

Here is another example, code for video is here.