艾思AIAdmin框架开发平台指导意见

北京中科专家 https://wapjbk.39.net/yiyuanzaixian/bjzkbdfyy/

指导意见与规范

再次强调注释的重要性,你认为的一眼就能看懂的代码,不是所有人都能一眼看懂,也可能你过几个月之后也不确定了;请务必多写注释

注释代码要准确,清楚,有意义.错误的,没有意义的注释,不如没有.(拷贝代码,代码改了请一定把注释一起进行修改)

最好的注释不只是说明实现了什么,做了什么,最好还有为什么这么做

除必要情况,禁止随意在代码中使用大量换行,一般情况下行与行之间使用单行空白行或两行空白

除必要情况,代码中禁止含有大量废弃代码注释行.

常用控制器方法命名规范:

添加/保存:edit

分页列表:lists

详情页:detail

删除:del

不分页列表:ls(注意,当表内数据过多,比仿说超过50条时谨慎使用,因为此方法是返回所有的表内数据.不是所有表都有这个方法)

查询前20条列表:search(不是所有表都有这个方法)

PHP和JS虽然都是弱类型语言,但是还是要理解它们的数据类型,特别是PHP开发人员,如果对理解,或不注意变量类型,会对前端开发人员造成很大困扰

建议把中文输入法的符号改为英文符号;也就是说不管输入中文还是英文,全部使用英文半角符号;

代码在保证安全性,性能,可读性等条件下,以少为美;

同一个方法或函数,总体行数为一屏全部显示为优,45行以内,当一个方法或函数超过45行时,要考虑是否重构;

理解类的概念,避免出现和类不相关的内容;比仿说:新闻类中,出现新闻分类的列表方法,这是不符合面向对象思想的;

前端开发指导意见

开发工具统一使用VSCode

表格的对齐方法:一般文本左对齐,数字右对齐,操作按钮居中对齐

表格的宽度要单独定义:一般ID宽度70px,80px,px;状态的宽度:70px,80px,px

表格通用以可能最长的,或不定长度的定段为自适应宽度(不设置宽度),这种字段在一个表格中通常一到两个,不要出现所有宽度都自适应的情况

PHP开发指导意见

开发工具统一使用VSCode,安装PHPIntelephense(PHP代码格式化)插件;搜索:Format:Braces选择:kr,统一使用kr样式格式化代码.

BetterAlign插件的使用windows:ctrl+alt+=mac:control+


转载请注明:http://www.aierlanlan.com/cyrz/5075.html