LW前端代码规范

LW前端代码规范

1. git分支命名规则
  • 普通分支:name-type-description
    例子:
    aaron-fix-objList
  • 临时公共分支
    master-description
    例子:
    master-form
2. 变量命名
  • 普通变量:小驼峰
    例子:
    userName
  • 常量、枚举值:全大写+下划线分割
    例子:
    MAX_LENGTH
    NUMBER_AUTO
3.组件属性命名
  • 普通属性:小驼峰
    例子:
<Com title = "标题" />
  • 类型属性:大驼峰
    例子:
<Com SubCom={SubTableCom} />
4.类型命名(class、interface、type、enum、namespace

大驼峰
例子:

class UserManager{

}
5.组件命名

大驼峰
例子:

<SubTable title="子表单" />
6.class内代码组织顺序
  • 变量
  • 构造函数
  • 抽象方法
  • 复写的方法(例如组件生命周期)
  • 自定义方法
  • 组件render方法
7.文件组织方式

模块下多个公用组件组合在components文件夹内
/components/SubTable
/components/StatefulTable
无样式的组件直接使用大驼峰命名文件
/SubTable.tsx
带样式组件使用大驼峰命名文件夹,内部使用index命名
/SubTable/index.tsx
/SubTable/index.css
模块下多个公用组件组合在dto文件夹内(少量类型可汇总到单个dto文件中)
/object/dto/FieldType.ts
/object/dto/FieldDetail.ts

8.注释相关

类型、函数使用说明注释

/**
 * 用户管理
 * @author aaron
 */
class UserManager {

  /**
   * 添加用户
   * @param user 用户信息
   * @return 结果是否添加成功
   */
  addUser(user: User): boolean {
    // 添加用户
    ...

    return true;
  }
}

静态变量、枚举 使用文档注释

/** 最大字数 */
export const MAX_LENGTH = 50; 

export enum FieldType {
  /** 单行文本 */
  TEXT_SINGLE = 'TEXT_SINGLE',
  /** 多行文本 */
  TEXT_MULTI = 'TEXT_MULTI',
}
9.其他
函数强制加上返回类型
function processUserName(user: Uesr): string {
  return userName;
}
支持ref调用的组件使用类型约束行为
interface FormInstance {
  setFieldValues: (values:ValueMap) => void;
}
10.css相关
  • 不推荐原子化方式
  • className使用小驼峰命名方式(cs.userName)
内容概要:本文档定义了一个名为 `xxx_SCustSuplier_info` 的视图,用于整合和展示客户(Customer)和供应商(Supplier)的相关信息。视图通过连接多个表来获取组织单位、客户账户、站点使用、位置、财务代码组合等数据。对于客户部分,视图选择了与账单相关的记录,并提取了账单客户ID、账单站点ID、客户名称、账户名称、站点代码、状态、付款条款等信息;对于供应商部分,视图选择了有效的供应商及其站点信息,包括供应商ID、供应商名称、供应商编号、状态、付款条款、财务代码组合等。视图还通过外连接确保即使某些字段为空也能显示相关信息。 适合人群:熟悉Oracle ERP系统,尤其是应付账款(AP)和应收账款(AR)模块的数据库管理员或开发人员;需要查询和管理客户及供应商信息的业务分析师。 使用场景及目标:① 数据库管理员可以通过此视图快速查询客户和供应商的基本信息,包括账单信息、财务代码组合等;② 开发人员可以利用此视图进行报表开发或数据迁移;③ 业务分析师可以使用此视图进行数据分析,如信用评估、付款周期分析等。 阅读建议:由于该视图涉及多个表的复杂连接,建议读者先熟悉各个表的结构和关系,特别是 `hz_parties`、`hz_cust_accounts`、`ap_suppliers` 等核心表。此外,注意视图中使用的外连接(如 `gl_code_combinations_kfv` 表的连接),这可能会影响查询结果的完整性。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值