How do I document a c# dll

前端 未结 4 1819
感动是毒
感动是毒 2021-01-18 02:08

How do I write a class so that property and method descriptions are visible to people referencing the dll in other projects?

    [Description(\"My age in yea         


        
相关标签:
4条回答
  • 2021-01-18 02:16

    Did you build the XML documentation file for your second case?

    Project properties -> Build -> [Output] XML Documentation file

    0 讨论(0)
  • 2021-01-18 02:17

    The description provided in DescriptionAttribute is visible in Property Grid for sure and it has nothing to do with code editor.

    For XML comments to be available, you have to generate an XML documentation file and ship it with your assembly.

    0 讨论(0)
  • 2021-01-18 02:23

    The second should work (summary), be sure to select in the project Properties (Build -> Output ) XML Documentation File.

    0 讨论(0)
  • 2021-01-18 02:37

    In Visual Studio:

    Project -> Properties -> Build -> Check "XML Documentation File".

    For further details, see XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files.

    0 讨论(0)
提交回复
热议问题