website icon indicating copy to clipboard operation
website copied to clipboard

Published 20 hours ago • verified publisher icon cake-build

Add best-practices for documenting extensions

Open pascalberger opened this issue 4 years ago • 1 comments

We should add best-practices how to document extensions for best integration with Cake website.

Points to consider:

  • Add XML comments
    • Summary on aliases class
    • Examples for aliases
    • Category on class and aliases
  • Tags on NuGet packages
  • Add XML documentation files to NuGet packages

pascalberger avatar Nov 22 '20 22:11 pascalberger

See also discussion in https://github.com/cake-build/website/issues/24

pascalberger avatar Nov 23 '20 19:11 pascalberger