Skip to content

doc(Component): Make code documentation readable for non-Chinese readers #7530

@peereflits

Description

@peereflits

Document describing which component

AS A non-Chinese speaking developer that wants to contribute to BootstrapBlazor
I WANT TO be able to read the code documentation and comments in English (assuming every .NET developer at least can read English)
SO I CAN better understand the code which eases my contribution

This is followup from discussion 7513.

Proposes solution:

/// <summary>
///   <para lang="zh">ContextMenuItem 类</para>
///   <para lang="en">A type for items in a context menu.</para>
/// </summary>
public class ContextMenuItem : ComponentBase, IContextMenuItem, IDisposable
{
    /// <summary>
    ///  <para lang="zh">获得/设置 显示文本</para>
    ///  <para lang="en">The text to display.</para>
    /// </summary>
    [Parameter]
    public string? Text { get; set; }

    /// <summary>
    ///  <para lang="zh">获得/设置 图标</para>
    ///  <para lang="en">The CSS class name that represents an icon (if any)</para>
    /// </summary>
    /// <example>
    /// Icon="fa-solid fa-bookmark"
    /// </example>
    [Parameter]
    public string? Icon { get; set; }

    /// <summary>
    ///  <para lang="zh">获得/设置 是否被禁用 默认 false 优先级低于 <see cref="OnDisabledCallback"/></para>
    ///  <para lang="en">Flags whether this menu item is disabled. Default <lang word="false"/>. Priority is lower than <see cref="OnDisabledCallback"/>.</para>
    /// </summary>
    [Parameter]
    public bool Disabled { get; set; }

// ... Other properties

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions