question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improvements to documentation comments (that compilers output).

See original GitHub issue

Hi,

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:closed
  • Created 9 years ago
  • Reactions:17
  • Comments:9 (5 by maintainers)

github_iconTop GitHub Comments

4reactions
gaftercommented, Aug 15, 2016

This seems like a nice potential enhancement to the expressiveness of the doc facility.

3reactions
daveaglickcommented, Mar 20, 2017

@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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Best practices for writing code comments
Best practices for writing code comments · Rule 1: Comments should not duplicate the code. · Rule 2: Good comments do not excuse...
Read more >
Documentation comments - C# language specification
C# provides a mechanism for programmers to document their code using a comment syntax that contains XML text. In source code files, comments...
Read more >
How to Write Doc Comments for the Javadoc Tool
As much as possible, write doc comments as an implementation-independent API specification. Define clearly what is required and what is allowed to vary...
Read more >
Analyzing Documentation Comments
Scan the declarations in the source code, looking for those that might have documentation comments of interest. Scan the documentation comments. The examples ......
Read more >
Feature Request: Lighter syntax for doc comments #85
XML Doc comments are verbose, ugly, and annoying to write and read, even with the IDE support Visual Studio provides.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found