Improvements to documentation comments (that compilers output).
See original GitHub issueHi,
Please add <inheritdoc />
tag or similar:
I think it would be really handy if the compiler(s) when outputting the documentation XML file if it could use inherited documentation where available/requested. Though I am not sure what should be output if there is no documentation available.
Please add the ability to add documentation comments for Namespace/Assembly:
Currently if you want to do this for tools that generate documentation html etc. you have to add a dummy class and add the documentation comments to them. This one is a bit trickier because there aren’t any viable options for doing them directly in code. There is nothing you could put the assembly documentation against in code and namespaces are “declared” possibly in multiple files. The only thing I could really think of is a separate XML file that gets merged into the documentation XML file that is output.
Cheers, dfkeenan
P.S. A Diagnostic and Code Fix that generates document comments for me would also great 😃
Issue Analytics
- State:
- Created 9 years ago
- Reactions:17
- Comments:9 (5 by maintainers)
Top GitHub Comments
This seems like a nice potential enhancement to the expressiveness of the doc facility.
@drauch @gafter DocFx is a separate tool and not part of the language or compiler. As the author of a .NET documentation tool I would really like to see support for
<inheritdoc>
exposed through the Roslyn XML documentation objects directly. I’m happy to reopen this over at csharplang if needed.