注释

  • 所有手动新增的方法都需要文档级注释,用中文说明这个方法的功能

    示例

    /// <summary>
    /// 获取牙位控件中当前选中牙位
    /// </summary>
    /// <param name="e"></param>
    /// <returns></returns>
    public static string getPosition(ToothChangedEventArgs e){
        ...
    }
    
  • 所有手动新增的属性都需要文档级注释,用中文说明这个属性的作用

    示例

    /// <summary>
    /// 医生姓名(模糊搜索)
    /// </summary>
    public string Name { get; set; }
    
  • 所有手动新增的类都需要文档级注释,用中文说明这个类的主要作用

    示例

    /// <summary>
    /// 销售发货单管理
    /// </summary>
    public class SalesDeliveryOrderManager : BaseManager{
        //编写注释后 视图层public SalesDeliveryOrderManager 代码鼠标放上去就知道这个字段的作用了
    }
    
  • 所有手动新增的枚举都需要文档级注释

  • 所有手动新增的字段都需要简单的行级注释

    //正在加载销售订单
    public bool _isLoadingOrder = false;
    //列表查询分页
    private frmSalesManagementSearch _frmSalesManagementSearch = null;
    

results matching ""

    No results matching ""