# scut_fun_dialect

**Repository Path**: turee43434/scut_fun_dialect

## Basic Information

- **Project Name**: scut_fun_dialect
- **Description**: 华南理工大学专题一课程作业。
- **Primary Language**: Kotlin
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-10-14
- **Last Updated**: 2021-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Android, Kotlin, SCUT

## README

- stand with Karl Heinrich Marx
- stand with communist
- stand with Vladimir Ilyich Ulyanov

# 在编写代码和提交需求之前请看此文档
此文档讲记录关于编写代码和提交需求时的规范。  
代码目标 **代码稳定>代码简单>技术复杂度**  
大家编写代码之前请在群里通知一声，如果有别人再写就别写了，如果俩人写的不一样我可以合并冲突。  
编写代码之前请记得同步代码。
编写完成后请记得推送代码。有bug也可以推送，后面的人可以帮你改，你写清楚bug在哪里就行。  
部分动效将使用compose编写，但是这不影响大家用xml编写界面。
**不许用强制推送，也就是git push -g。此代码非常危险，可能导致前功尽弃**
## issue提交规范 
- 对于需求，请在issue中提出。issue是一个很好用的需求管理工具，在那里面还可以观察到每个人的工作量。  
- 我们的目的是让这个程序能够正常运行，界面漂亮美观一点，顺便锻炼一下协作能力，**不是为了产出高性能代码**的，所以说代码部分的要求不会很高，能跑就行。  
- 其他规范：在提交issue的时候按照模板来写就行。  
如何处理美观？  
- 我们会大量引入别人的控件/数据可视化。
- 之前我从github上面找的土味儿控件就算了，真的太土了。

## Kotlin代码编写规范
- 使用id 'kotlin-android-extensions'自动提供的控件类,不要使用Binding，现在版本的binding很不稳定容易报错。当然**finitembyid**也行，虽然不好看但是很他稳定不出bug。
- 请尽量不要使用语法糖，kotlin的语法糖会导致可读性大大减弱，或者写注释。  
- UI尽量使用jetpack。
- 需要写注释。自定义函数前，难以理解的语句前都需要注释。
- 变量命名遵循驼峰法则。

## XML语言编写规范
- 组件的id命名规则：【所在xml名称的简写】+【组件名称简写】+其他描述。
如命名 **mainBtnToSearchpage**，表示主页面xml文件中一个按钮，按钮的用途是前往搜索页面。
- 没事儿尽量别乱改颜色，容易出事儿。
- 黄色警告（warming）可以不管。反正不会让程序崩溃。