jinyafeng / documentationassistant Goto Github PK

Add support for <inheritdoc/> comments

This (much wanted) feature was added with visual studio 2019 16.4:
https://developercommunity.visualstudio.com/idea/412325/add-intellisense-support-for-the-tag-in-xml-docume.html

Official Microsoft Docs:
https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/inheritdoc

Do not throw warnings/errors when the inheritdoc tag is used:

It's great to see the extension of this sort. Really glad GhostDoc is no longer the only option. Love it

After going through the list of issues I have noticed that a few issues are poping up again and again and it seems like your users really want to get the desired functionality:

• Allow conditionally exclude non-public members. It is the same as #6 and it is still not fixed even though the issue is closed:
  As you can see below the right extension is still generating warnings:
  
  
  I suggest that instead of creating two extensions with slightly different functionality you simply allow your users to choose to enable/disable the functionality they want. You will never have them agree so let them choose instead 😄
  The configuration page seems to exist judging from the #8 thread. But at least on V2022, the options dialog does not have it available.
• Another enhancement that was asked a few times is the hotkey binding for the "Fixing missing documentation header" (#5).
  As it was mentioned one can use Ctrl+. or Alt+Enter. Though this is not an adequate equivalent as it simply triggers the context menu. And then it requires menu navigation and the selection of the fix scope.
  Though the users are asking for a simple single-step action (for the signature at the cursor) identical to Ctrl+Shift+D so familiar in GostDoc.
  If you just expose the command used can bind it by itself.

When using the context menu to add documentation to a top-level entity such as a class or interface, the initial template adds an additional line break between the closing </summary> tag and the code. For example,

/// <summary>
/// The project service.
/// </summary>

public class ProjectService : IProjectService
...

Seen in Visual Studio 2022 Preview and Visual Studio 2022.
DocumentationAssistant v. 1.7.0

Can you support selecting a file and automatically adding XML comments to all class public and other attribute methods in this file
it like ghostdoc

For some reason the extension is marking code in aspx files for documentation, happens also for built-in methods of asp controls.

As you can see here, not all methods are marked, even when they are the same:

The first DataBinder.Eval isnt, the second is.

Hi,

DocumentationAssistantPublicMembersOnlyPreview seems to work fine but show me warnings for public members on private classes. Is it possible to do something?
Thanks for your work on this extension.

Originally posted by @oansquer in https://github.com/jinyafeng/DocumentationAssistant/issue_comments/693643966

Hello,

This is not an error, but a request:

Would it be possible (if not already) to update the documentation when parameters are added or removed?

It's not a lot of work to do, but if you do batch adding or removing parameters, it would save a lot of time.

Thank you very much and greetings.

I came across your extension because Ghost Doc is getting a bit too bloated for my liking.
The following additions would really make your extension more useful for me:

• Applying the fix by using a keystroke. A nice default would be: CTRL-SHIFT-D
• Excluding non-public members by default. We only tend to document our public API. Would be really nice to have a way to configure when to display the warning.

How do I use it? You provided no documentation.

Do I use a key stroke? Or is there another way? I'd like to add documentation to existing code.

Applying the fix by using a keystroke. A nice default would be: CTRL-SHIFT-D

I have a class that is distributed over multiple files using the "partial class" statement. I added a summary to class in the main file. In the other files the class name still gets underlined and a warning is generated the a documentation header is required.

I am new to C# so I don't know what the convention is here, but I don't want to maintain the same summary text on multiple files. How would I handle that situation?

Hello,

I checked the new option:

I restarted Visual Studio 2019 but I have warnings on private members:

Is this a bug?

Thank you.

Olivier Ansquer

Generics should include their typeparams in the cref of the constructor.

Actual (invalid):

public class MyGeneric<T, K>
{
    /// <summary>
    /// Initializes a new instance of the <see cref="MyGeneric"/> class.
    /// </summary>
    public MyGeneric() {}
}

Expected:

public class MyGeneric<T, K>
{
    /// <summary>
    /// Initializes a new instance of the <see cref="MyGeneric{T, K}"/> class.
    /// </summary>
    public MyGeneric() {}
}

Note that because these are XML comments the comments use curly-brackets instead of angle-brackets.

Support a button to generate comments for all members.

The idea is from one user's question https://marketplace.visualstudio.com/items?itemName=jinyafeng.DocumentationAssistant&ssr=false#qna.