代码规范简版

  • 公共组件不能有副作用
  • 判空操作符替代对象属性判断
    get('/home/datamgr/v2/system_config?configName=DATAMGR, {}).then((res) => {
      const data = (res && res.data) || {};
      store.set('houseHoldBindMode', data.data);
    });
    get('/home/datamgr/v2/system_config?configName=DATAMGR,GRID', {}).then((res) => {
      const data = res?.data?.data || {};
      store.set('houseHoldBindMode', data.DATAMGR_BUIDLING_HOUSE_BIND_MODE);
      store.set('isDutyGird', !!Number(data.DATAMGR_PATROL_FILTER_BY_DUTY_GRID));
    });

  • switch代替冗杂的if判断
  const controlShowBySwitchChange = (flag) => {
    form.validateFields().then((values) => {
      const { displayFontCon, topCascadeField, linkageAssign, securityGrade } = values;
      if (flag === 1) {
        if (displayFontCon) {
          if (!isShowDisplayFontCon) {
            form.setFieldsValue({
              relDisplayField: '',
              relDisplayFieldValue: '',
              displayFontConType: false,
              selfDisplayFieldValue: '',
            });
            setRelateDisplayValueList([]);
          }
        }
        setIsShowDisplayFontCon(displayFontCon);
        setIsShowDisplayFontConType(false);
      } else if (flag === 2) {
        setIsShowTopCascadeField(topCascadeField);
      } else if (flag === 3) {
        setIsShowLinkageAssign(linkageAssign);
      } else if (flag === 4) {
        if (form.getFieldValue('securityGrade') === 'encryption-level') {
          get(`/home/datamgr/v2/meta_field/encrypt_check/${fieldID}`, {}).then((res) => {
            if (res && res.message) {
              message.error(res.message, [5]);
            }
          });
        }
        form.setFieldsValue({
          encryption: null,
          desensitizationRule: null,
        });
        setIsShowEncryption(securityGrade === 'encryption-level');
        setIsDesensitizationRule(securityGrade === 'internal-level');
      }
    });
  };
const controlShowBySwitchChange = (flag) => {
    form.validateFields().then((values) => {
      const { displayFontCon, topCascadeField, linkageAssign, securityGrade, autoCode } = values;
      switch (flag) {
        case 1:
          if (displayFontCon) {
            if (!isShowDisplayFontCon) {
              form.setFieldsValue({
                relDisplayField: '',
                relDisplayFieldValue: '',
                displayFontConType: false,
                selfDisplayFieldValue: '',
              });
              setRelateDisplayValueList([]);
            }
          }
          setIsShowDisplayFontCon(displayFontCon);
          setIsShowDisplayFontConType(false);
          break;
        case 2:
          setIsShowTopCascadeField(topCascadeField);
          break;
        case 3:
          setIsShowLinkageAssign(linkageAssign);
          break;
        case 4:
          if (form.getFieldValue('securityGrade') === 'encryption-level') {
            get(`/home/datamgr/v2/meta_field/encrypt_check/${fieldID}`, {}).then((res) => {
              if (res && res.message) {
                message.error(res.message, [5]);
              }
            });
          }
          form.setFieldsValue({
            encryption: null,
            desensitizationRule: null,
          });
          setIsShowEncryption(securityGrade === 'encryption-level');
          setIsDesensitizationRule(securityGrade === 'internal-level');
          break;
        case 5:
          setIsShowAutoCode(autoCode);
          break;
        default:
          break;
      }
    });
  };
  • 拒绝魔法数字 用枚举代替,没有ts就用对象代替,上面switch就很典型
export const linkageAssignTypesEnum = {
  equivalent: 1,
  splicing: 2,
  trinocular: 3,
  dateCalculate: 4,
};

export const dateCalculateRulesEnum = {
  add: 1,
  subtract: 2,
};
  • import除了兄弟结构用相对路径,其他情况一律用在 webpack 中配置的别名
import Overview from '@/pages/payy/dashboard_liaocheng/overviewHospital';
import Warning from '@/pages/paxy/dashboard_dark/warning';
import GridCheck from '@/pages/paxy/dashboard_dark/gridCheck';
import Security from '@/pages/paxy/dashboard_dark/security';
  • 尽量使用 es6 语法,如解构,给定默认值,let,const,箭头函数,await async
  • 严格遵守eslint规范,不要随意使用disable注释去避开代码检查
  • 确保单个函数单一职责代码不超过50行
  • 别重复自己 消除重复代码,适当封装组件或方法
  • 没必要不注释包括且限于提供信息&意图解释&阐释&警示 &TODO
  • 用有意义的命名来定义逻辑判断条件
    const isShowHeadImg = field.dataFieldAttr.isShowHeadImg;
    const canShowFlag = field.dataFieldAttr.canShowFlag;
    const isHideAutoValueField = (isEdit || isAdd) && field.dataFieldAttr.canAutoValue;
    // 责任网格特殊处理
    const isGridField = field?.fieldName.split('@')[1] === 'grid_name';

React相关

  • Hook代替高阶组件HOC
  • 文件,文件夹名使用小驼峰
  • 组件引用时使用大驼峰
  • 对于 render 函数返回内容过多时(50 行),尽量拆分组件, 表单例外。
const Left = () => {
  const { hiddenLeft } = useContext(HomeContext);
  return (
    <TweenOne animation={{ left: '-30%', duration: 800 }} reverse={!hiddenLeft}>
      <Overview />
      <Warning type={2} />
      <Security style={{ height: '23%' }} type={1} />
      <GridCheck subBlockTitleText={'医患纠纷'} />
    </TweenOne>
  );
};

参考文献:

《代码整洁之道》

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 1 编码风格 1.1 缩进 1.1.1【强制】使用 2 个空格缩进。eslint: indent[https://...
    朕小六阅读 765评论 0 1
  • 1 文件与目录 1.1 文件命名 1 文件与目录的命名可以使用的字符为[A-Z, a-z, 0-9, ., _, ...
    rick_2016阅读 11,552评论 0 9
  • 一、编程规约 (一)命名规范 1.1.1 项目命名 全部采用小写方式, 以中划线分隔。 1.1.2 目录命名 全部...
    Xincol阅读 224评论 0 0
  • 最近写python对于一些代码规范问题感觉有些地方自己还需要加强,翻阅很多文章,特此奉上官方中文翻译版以便日后查看...
    PeterPZ阅读 3,571评论 0 15
  • 技术点: 不定期更新补充 页面引用svg symbol标签创建icon p:nth-child(2) 与 p:nt...
    wwmin_阅读 1,514评论 0 52