Open sharwell opened 5 months ago
For additional context for troubleshooters, the original implementation in F# looks like below.
/// <summary>
/// Represents a list item.
/// </summary>
type ListItem = {
/// The unique ID of the item.
Id: int
/// The name of the item.
Name: string
/// True when the item is completed, otherwise false.
IsComplete: bool
}
Background and Motivation
AB#2063157 https://developercommunity.visualstudio.com/t/Documentation-Comments-in-F-library-not/10661462
In this example, there is no documentation presented when covering over the tokens marked with
^
. This occurs because the constructor forListItem
does not have any documentation comments, even though the containing type does.Proposed Solution
Treat constructors with missing documentation comments as automatically inheriting documentation from their containing type.
Alternative Designs
Risks
Could lead to duplication of complicated type documentation across every constructor for that type during documentation generation.