You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Go to file
p9fzr4vik 827afcbb94
Merge pull request '文档和代码注释' (#4) from ljf_branch into main
3 months ago
.gradle update readme 5 months ago
.idea Merge pull request '何思源的内容' (#3) from hsy_branch into main 3 months ago
app Merge pull request '何思源的内容' (#3) from hsy_branch into main 3 months ago
doc 创建新的空项目 5 months ago
gradle 创建新的空项目 5 months ago
javadoc 导入依赖 5 months ago
lib 导入依赖 5 months ago
manager 本地构建成功 6 months ago
src/Notes-master 创建新的空项目 5 months ago
.gitignore 创建新的空项目 5 months ago
DataUtils.java ADD file via upload 3 months ago
LICENSE.txt 导入依赖 5 months ago
NOTICE.txt 导入依赖 5 months ago
Note.java ADD file via upload 3 months ago
README.md Update README.md 5 months ago
RELEASE_NOTES.txt 导入依赖 5 months ago
WorkingNote.java ADD file via upload 3 months ago
build.gradle.kts 创建新的空项目 5 months ago
gradle.properties 修正需要需要常量表达式问题 5 months ago
gradlew 创建新的空项目 5 months ago
gradlew.bat 创建新的空项目 5 months ago
local.properties update readme 5 months ago
settings.gradle.kts 创建新的空项目 5 months ago
文档-开源软件维护方案及成果.docx ADD file via upload 3 months ago
文档-软件设计规格说明书.doc ADD file via upload 3 months ago
文档模板-软件需求构思及描述模板.docx ADD file via upload 3 months ago
文档模板-软件需求规格说明书模板.docx ADD file via upload 3 months ago

README.md

一、项目目录结构

二、分支管理策略

  1. master分支:存储稳定版本代码,仅合并经过测试的develop分支内容。
  2. develop分支:作为日常开发主分支,集成所有成员功能开发分支代码。
  3. 成员分支:每位成员独立开发、注释代码的分支,命名为member-name-feature
    任务类型 具体内容 交付物
    代码获取与环境搭建 从开源渠道获取小米便签代码配置Android开发环境JDK、Android Studio 可运行的项目工程
    代码注释 对核心代码模块添加详细注释,说明功能逻辑、参数含义及关键流程 src/java/下带注释的Java文件
    UML图绘制 绘制用例图(用户功能需求)、类图(代码结构),确保准确反映系统架构 doc/reading-report/*.uml文件
    泛读报告撰写 分析系统架构、核心功能模块、技术实现结合UML图说明设计思路 doc/reading-report/report.md
    质量分析报告 从代码规范性、可维护性、性能等维度评估,提出优化建议 doc/quality-report/report.md
    最终整合与提交 合并所有分支代码与文档,检查格式规范,提交至平台 完整的mi-note-project目录

三、项目功能模块概述

便签操作

文件夹

菜单

闹钟提醒

打电话

发短信

超链接

四、文档

模型模板

gradle8.11.1

  • 软件设计需求
  • 软件需求模型

文档模板

  • 开源代码质量分析报告
  • 开源软件维护方案及成果
  • 软件设计规格说明书
  • 软件需求构思及描述
  • 软件需求规格说明书

五、协作流程

  • 初始化阶段:克隆代码至master分支,搭建环境后推送到develop
  • 开发阶段:成员从develop拉取分支开发完成后提交Pull Request至develop
  • 评审阶段:小组共同审查代码注释与报告,修正问题。
  • 合并与提交:将develop分支合并至master,打包srcdoc目录提交作业。

六、工具使用

  • 开发工具Android studio

  • UML图绘制EdrawMax矢量绘图软件

  • 版本管理通过Git命令行GitHub desktop和头歌平台管理分支与提交记录