简体   繁体   中英

c# - module documentation - XML documentation file

I am studying C# in my HDN school with Visual Studio. In Windows there is a way to generate automaticaly the technical documentation from modules by going through Project > Properties and by clicking on "XML documentation file".

On Visual Studio for Mac I do not see this functionality.

May someone help me? Does it exist or should I write manually the /// up to the module?

You can also add a configuration to the.csproj so the documentation file gets generated with each build. Follow this SO:

https://stackoverflow.com/a/47118584/4122889

Add this code to you.csproj file

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

Or create a Directory.Build.Props file in the root of your repo and add this:

<Project>
  <PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
  </PropertyGroup>
</Project>

More info on Directory.Build.Props (or.Targets): https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-your-build?view=vs-2019

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM