Conversation
Contributor
Reviewer's GuideUpdates XML documentation comments for several attribute classes to improve bilingual (Chinese/English) clarity, conciseness, and formatting, without changing runtime behavior. File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- In the
TableMetadataForAttributeXML comments, the example section now mixes Chinese and English in a single<para>withoutlangattributes; consider keeping separate<para lang="zh">/<para lang="en">blocks for clearer localization and consistent rendering tooling. - For
JSModuleNotInheritedAttribute, you could add a<see cref="JSModuleAutoLoaderAttribute"/>reference in the XML summary (e.g., “does not inherit from ”) to make the relationship more discoverable in IntelliSense.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the `TableMetadataForAttribute` XML comments, the example section now mixes Chinese and English in a single `<para>` without `lang` attributes; consider keeping separate `<para lang="zh">`/`<para lang="en">` blocks for clearer localization and consistent rendering tooling.
- For `JSModuleNotInheritedAttribute`, you could add a `<see cref="JSModuleAutoLoaderAttribute"/>` reference in the XML summary (e.g., “does not inherit from <see cref="JSModuleAutoLoaderAttribute"/>”) to make the relationship more discoverable in IntelliSense.
## Individual Comments
### Comment 1
<location path="src/BootstrapBlazor/Attributes/TableMetadataForAttribute.cs" line_range="11-13" />
<code_context>
-/// <para lang="en">Example:</para>
-/// <para lang="en">the Pig data type is usually at biz or data layer</para>
-/// <code>
+/// <para>示例：Pig 数据类型通常位于业务层或数据层; Example: the Pig data type is usually at biz or data layer</para>
+/// <code>
/// public class Pig
</code_context>
<issue_to_address>
**suggestion:** Avoid mixing languages in a single XML doc paragraph to keep localization clearer.
Previously, zh/en text was split into separate `<para>` elements with `lang` attributes, which is better for localized tooling and for readers. Here both languages are merged into one `<para>` with a semicolon. Please restore separate `<para lang="zh">` and `<para lang="en">` entries so each audience has a clear sentence and tooling can distinguish them.
```suggestion
— We need to split the mixed-language `<para>` into two localized paragraphs, restoring `lang` attributes for tooling and clarity.
/// <example>
/// <para lang="zh">示例：Pig 数据类型通常位于业务层或数据层</para>
/// <para lang="en">Example: the Pig data type is usually at biz or data layer</para>
/// <code>
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
11
to
+13
| /// <example> | ||
| /// <para lang="zh">示例：</para> | ||
| /// <para lang="zh">Pig 数据类型通常位于业务层或数据层</para> | ||
| /// <para lang="en">Example:</para> | ||
| /// <para lang="en">the Pig data type is usually at biz or data layer</para> | ||
| /// <code> | ||
| /// <para>示例：Pig 数据类型通常位于业务层或数据层; Example: the Pig data type is usually at biz or data layer</para> | ||
| /// <code> |
Contributor
There was a problem hiding this comment.
suggestion: Avoid mixing languages in a single XML doc paragraph to keep localization clearer.
Previously, zh/en text was split into separate <para> elements with lang attributes, which is better for localized tooling and for readers. Here both languages are merged into one <para> with a semicolon. Please restore separate <para lang="zh"> and <para lang="en"> entries so each audience has a clear sentence and tooling can distinguish them.
Suggested change
| /// <example> | |
| /// <para lang="zh">示例：</para> | |
| /// <para lang="zh">Pig 数据类型通常位于业务层或数据层</para> | |
| /// <para lang="en">Example:</para> | |
| /// <para lang="en">the Pig data type is usually at biz or data layer</para> | |
| /// <code> | |
| /// <para>示例：Pig 数据类型通常位于业务层或数据层; Example: the Pig data type is usually at biz or data layer</para> | |
| /// <code> | |
| — We need to split the mixed-language `<para>` into two localized paragraphs, restoring `lang` attributes for tooling and clarity. | |
| /// <example> | |
| /// <para lang="zh">示例：Pig 数据类型通常位于业务层或数据层</para> | |
| /// <para lang="en">Example: the Pig data type is usually at biz or data layer</para> | |
| /// <code> |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates XML documentation comments for a few attribute types to improve clarity/formatting as part of the ongoing component attribute documentation work (fixes #7779).
Changes:
- Refactors
TableMetadataForAttributeXML docs (summary/example/param formatting). - Updates
JSModuleNotInheritedAttributesummary text to be more descriptive. - Reflows
JSModuleAutoLoaderAttributeparameter XML docs into a multi-line<param>block.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/BootstrapBlazor/Attributes/TableMetadataForAttribute.cs | Rewrites summary/example XML docs and reformats <param> documentation. |
| src/BootstrapBlazor/Attributes/JSModuleNotInheritedAttribute.cs | Replaces placeholder summary with a descriptive zh/en summary. |
| src/BootstrapBlazor/Attributes/JSModuleAutoLoaderAttribute.cs | Reformats the path parameter XML docs for readability. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
11
to
+13
| /// <example> | ||
| /// <para lang="zh">示例：</para> | ||
| /// <para lang="zh">Pig 数据类型通常位于业务层或数据层</para> | ||
| /// <para lang="en">Example:</para> | ||
| /// <para lang="en">the Pig data type is usually at biz or data layer</para> | ||
| /// <code> | ||
| /// <para>示例：Pig 数据类型通常位于业务层或数据层; Example: the Pig data type is usually at biz or data layer</para> | ||
| /// <code> |
There was a problem hiding this comment.
<example> section mixes Chinese and English in a single <para> without lang attributes. This is inconsistent with the rest of the repo’s bilingual XML-doc pattern (separate <para lang="zh"> / <para lang="en">, e.g. Attributes/AutoGenerateColumnAttribute.cs) and makes it harder for tooling/readers to select the right language. Please split these into separate localized <para> entries (and keep the languages separate).
| /// <para lang="en">register metadata types in assembly</para> | ||
| /// <code> | ||
| /// </code> | ||
| /// <para>register metadata types in assembly</para> |
There was a problem hiding this comment.
The example text register metadata types in assembly is not localized (no lang attribute, and only English). To keep docs consistent and avoid mixed-language output, please provide both zh/en <para lang=...> entries here as well.
Suggested change
| /// <para>register metadata types in assembly</para> | |
| /// <para lang="zh">在程序集中注册元数据类型</para> | |
| /// <para lang="en">Register metadata types in the assembly</para> |
Comment on lines
+9
to
+10
| /// <para lang="zh">表示该类不继承 JSModuleAutoLoaderAttribute 的特性</para> | ||
| /// <para lang="en">Indicates that this class does not inherit the JSModuleAutoLoaderAttribute</para> |
There was a problem hiding this comment.
The summary text mentions JSModuleAutoLoaderAttribute as plain text. Using <see cref="JSModuleAutoLoaderAttribute"/> here (as done elsewhere in the codebase) would preserve clickable API links in generated docs and avoid drift between the zh/en summaries.
Suggested change
| /// <para lang="zh">表示该类不继承 JSModuleAutoLoaderAttribute 的特性</para> | |
| /// <para lang="en">Indicates that this class does not inherit the JSModuleAutoLoaderAttribute</para> | |
| /// <para lang="zh">表示该类不继承 <see cref="JSModuleAutoLoaderAttribute"/> 的特性</para> | |
| /// <para lang="en">Indicates that this class does not inherit the <see cref="JSModuleAutoLoaderAttribute"/>.</para> |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7780 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 764 764
Lines 33960 33960
Branches 4675 4675
=========================================
Hits 33960 33960
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #7779
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Update XML documentation comments for attribute classes to improve clarity and bilingual (zh/en) descriptions.
Documentation: