# flutter_code_framework

**Repository Path**: xu_shuhao/flutter_code_framework

## Basic Information

- **Project Name**: flutter_code_framework
- **Description**: Flutter 项目基础框架
- **Primary Language**: Dart
- **License**: Apache-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-04-15
- **Last Updated**: 2021-04-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

序列化demo

------------团队协助规范--------------

【命名规范】
1、文件名全部小写，单词之间用下横线分隔，英文全拼不要简写。如：startup_page.dart
2、类名首字母大写驼峰规则，名称与类文件名一致（下划线去掉改成驼峰）如：MyHomePage；
   文件内内嵌类名称：下划线+首字母大写驼峰规则。 如： _MyHomePageState
3、文件夹名称全部小写，单词之间用下横线分隔，英文全拼不要简写。 如: /home
4、局部变量名、方法名 下横线+首字母小写驼峰; 如： _counter、 _incrementCounter()
5、公开变量名、方法名 首字母小写驼峰; 如： counter、 _ncrementCounter()

【pubspec.yaml 维护规则】
1、添加第三方包，需备注对应用途功能、引入路径、调用方式、添加人员名称 。
   调用方式超过一行的，需要提供对应demo，并备注demo文件地址。
2、字体添加，需备注用途或依赖关系、添加人名称。

【文件头部注释与代码注释】
1、所有文件必须添加头部注释（文件创建人维护，后期代码调整人不同时，调整人名称备注在代码位置），统一格式并维护实际内容。
2、公共配置文件修改必须 实名流痕。
文件注释头格式如下： 可自行下载vscode插件，快速生成。插件名：vscode-fileheader-git  (需提前配置好本地git用户信息)
3、单文件多人维护情况，注释保留维护人姓名。 独立/复杂逻辑 独立方法并给出注释说明。

/*
 * @Author: 真实姓名 、 多人可以追加
 * @Email: git邮箱@*.com
 * @Date: 2020-04-15 15:51:40
 * @Last Modified by: 真实姓名 、 多人可以追加
 * @Last Modified time: 2020-04-19 21:59:01 调整后更新
 * @Description: 初始化App入口逻辑
 */

 【GIT 提交规则】
 1、个人安装的插件，自动产生的项目文件。需要维护根目录下 .gitignore文件。 防止上传垃圾文件（云服务空间有限）
 2、.gitignore 文件添加时 需要添加 添加人姓名（必须）  如：  ### 用户姓名全拼 ###
 3、注意代码分支，vscode左下角选择相应的代码分支进行获取或提交。 master默认只读；develop 可读写； master由专人根据开发进度阶段性合并。

 【android 、ios 文件夹说明】
 尽量不要手动干预，如需修改记得通知所有团队成员注意事项。
 

 —————————————————公共组件目录及介绍说明———————————————————
main.dart  入口文件
startup_page.dart  启动文件
/lib/common  公共文件，可根据实际情况创建子文件夹
/lib/models  model类，，可根据实际情况创建子文件夹
/lib/pages/  业务模块文件，根据具体的业务范围创建子文件夹
/lib/widgets 公共组件（可跨项目）
/lib/business_widgets 项目内公共组件（项目内使用）
/lib/demo/   demo示例与使用说明


1、组件与demo规则
2、阴影与过渡demo
3、暗黑模式规则
Brightness brightnessValue = MediaQuery.of(context).platformBrightness;
bool isDark =  brightnessValue == Brightness.dark;

IOS 验证有效 Android 袋验证

4、异形屏规则  ok top 44  bottom 34   设计时注意 @2 @3  SafeArea
5、颜色管理
6、TabBar动画
7、SF图标方案 ok


1、代码架构
文件夹规范、 文件名规范、 源代码头部注释规范、 基类规范、 样式规则、 嵌套规范（子文件夹规范）、 引入第三方包规范

布局安全区域规范、暗黑模式预留 

2、源代码管理配置   提交分支与修改信息备注必填
3、功能组件及demo
4、业务组件及demo