Skip to content

Source Code Comments Not Visible in NuGet Package #62

@mrafnadeem-apimatic

Description

@mrafnadeem-apimatic

We should enable the GenerateDocumentationFile setting in the project file.

This has a few advantages:

  • When we build the SDK for deployment to NuGet, the comments and documentation get included and the user can see the comments using Intellisense or by looking at the decompiled binaries
  • When building the SDK, the compiler gives warnings for any areas of code with missing or incorrect documentation

After enabling it, we would have to look at and address all the warnings by writing or fixing documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions