Skip to content
Open core software, built in Singapore Established 2018  /  Five utilities
Jering
Talk to us

InheritDoc

DevOps.AzurePipelines Jering documentation Open source Pipeline templates
Documentation menu

InheritDoc lets an implementation reuse the documentation of the interface or base member it overrides. It keeps comments consistent without copying the same paragraph into every implementation.

When it helps

Use it when the contract is already documented and the implementation does not add a meaningful restriction. Do not use it to hide a difference in behavior; if the implementation is stricter, say so.

Documentation output

Inherited comments appear in the generated XML documentation when the compiler can resolve the base member. Keep the interface comments complete, because every implementation depends on them.

Read XML Documentation for the build setting that produces the file.

Reference shelf