Skip to content

Add XML documentation for GlobalStatementSyntax #80697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+5 −0
Open

Add XML documentation for GlobalStatementSyntax #80697

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6a119b4
Initial plan
Copilot Oct 14, 2025
581f5ff
Add XML documentation for GlobalStatementSyntax
Copilot Oct 14, 2025
e0c6e74
Address code review: Consolidate documentation into summary section
Copilot Oct 14, 2025
c4bebcb
Clarify that each statement is wrapped in GlobalStatementSyntax
Copilot Oct 14, 2025
9afe043
Remove link to top-level statements proposal
Copilot Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...arpSyntaxGenerator/CSharpSyntaxGenerator.SourceGenerator/Syntax.xml.Internal.Generated.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9877,6 +9877,7 @@ internal override GreenNode SetAnnotations(SyntaxAnnotation[]? annotations)
=> new InterpolationFormatClauseSyntax(this.Kind, this.colonToken, this.formatStringToken, GetDiagnostics(), annotations);
}

/// <summary>Represents a global statement in a compilation unit. Each statement at the top level of a compilation unit is wrapped in a GlobalStatementSyntax node. Global statements are top-level statements that can appear in a C# program or script. In regular C# programs (C# 9.0+), they are synthesized into a Main method. In C# scripts, they are executed as top-level code. See https://github.com/dotnet/csharplang/blob/main/proposals/top-level-statements.md for more information.</summary>
internal sealed partial class GlobalStatementSyntax : MemberDeclarationSyntax
{
internal readonly GreenNode? attributeLists;
Expand Down
1 change: 1 addition & 0 deletions ...SharpSyntaxGenerator/CSharpSyntaxGenerator.SourceGenerator/Syntax.xml.Syntax.Generated.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6150,6 +6150,7 @@ public InterpolationFormatClauseSyntax Update(SyntaxToken colonToken, SyntaxToke
public InterpolationFormatClauseSyntax WithFormatStringToken(SyntaxToken formatStringToken) => Update(this.ColonToken, formatStringToken);
}

/// <summary>Represents a global statement in a compilation unit. Each statement at the top level of a compilation unit is wrapped in a GlobalStatementSyntax node. Global statements are top-level statements that can appear in a C# program or script. In regular C# programs (C# 9.0+), they are synthesized into a Main method. In C# scripts, they are executed as top-level code. See https://github.com/dotnet/csharplang/blob/main/proposals/top-level-statements.md for more information.</summary>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot remove the final 'see' statement.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in commit 8f3e5d2. Removed the final 'see' statement with the link.

/// <remarks>
/// <para>This node is associated with the following syntax kinds:</para>
/// <list type="bullet">
Expand Down
3 changes: 3 additions & 0 deletions src/Compilers/CSharp/Portable/Syntax/Syntax.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2243,6 +2243,9 @@
<!-- Statements -->
<Node Name="GlobalStatementSyntax" Base="MemberDeclarationSyntax">
<Kind Name="GlobalStatement"/>
<TypeComment>
<summary>Represents a global statement in a compilation unit. Each statement at the top level of a compilation unit is wrapped in a GlobalStatementSyntax node. Global statements are top-level statements that can appear in a C# program or script. In regular C# programs (C# 9.0+), they are synthesized into a Main method. In C# scripts, they are executed as top-level code. See https://github.com/dotnet/csharplang/blob/main/proposals/top-level-statements.md for more information.</summary>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link 404s. Does it really need to be here in the first place?

</TypeComment>
<Field Name="AttributeLists" Type="SyntaxList&lt;AttributeListSyntax&gt;" Override="true">
<summary>Always empty on a global statement.</summary>
</Field>
Expand Down