手机购物网站 设计,网站建设维护是做什么的,什么是企业网,91成长人版抖音安装代码规范
所有文件#xff0c;包括自动生成的编译文件package.json都要格式化#xff08;IDE快捷键CtrlAltL#xff09;#xff1b;函数命名#xff0c;C大驼峰#xff0c;TS、JS小驼峰#xff0c;函数命名注意动宾结构#xff1b;静态常量需使用全大写#xff0c;文…代码规范
所有文件包括自动生成的编译文件package.json都要格式化IDE快捷键CtrlAltL函数命名C大驼峰TS、JS小驼峰函数命名注意动宾结构静态常量需使用全大写文件目录使用全小写不建议包含特殊字符如-“和”_等类名使用大驼峰函数的参数、全局变量和局部变量都使用小驼峰命名要规范化见名知意if语句后必须跟“{”哪怕只有一行代码有break或return的条件先break或return再走其他的逻辑条件判断当一个分支达成条件时及时返回不需要再走其他分支代码中避免出现魔鬼数字需补上注释或者用符合语义的名词常量代替如下 // One minute has 60 seconds.let time 60const ONE_MINUTE 60let time ONE_MINUTE字符串拼接使用模板字符串组件使用除了宽高属性可以在一行其他的属性必须换行TS、JS中关于是否添加;“的问题风格要统一建议添加”;字符串和图片资源等的使用支持 r 使用的全部使用 r使用的全部使用 r使用的全部使用r引用新增文件注意开源协议、版权检查截图要使用真机效果图readme中使用“.”不要用“、”检查错别字异步方法中需要返回方法的返回值不用声明变量直接return如下 return await this.mediaTest.getFileAssets(fetchOp)方法中的参数需要类型声明import 文件顺序同类型放一起string.json中description要写简要描述zh下要用中文TS、JS语言缩进为2格C语言缩进为4格涉及应用截图时图片不能包含人物、关键信息、网络等有侵权风险的资源工程中不要配置签名信息禁止上传local.properties和package-lock.json等系统自动生成的文件规范日志格式统一用[Sample_包名]开头如时钟日志使用[Sample_Clock]日志打印需要使用Hilog接口建议封装单独的Logger类 示例如下
import hilog from ohos.hilog
...
class Logger {private domain: number 0xFF00private prefix: string [Sample_Clock]private format: string %{public}, %{public}...debug(...args: any[]) {hilog.debug(this.domain, this.prefix, this.format, args)}...
}注释“//”后要加一个空格如果注释跟在代码后面则“//”前要加一个空格 // 正确示例let a 10let a 10 // 正确示例代码中避免出现中文字符要使用资源代替符合国际化开发标准应用包名统一使用“com.samples.xxx”“xxx”为特性名称
ReadMe编写规范 标题以特性名称命名 介绍介绍sample用了哪些包具有哪些功能给出完整包名并附上链接 效果预览屏幕截屏或者视频文件不超过4个 3.1 使用说明介绍应用的使用说明具体的操作步骤和用法信息示例如下 在主界面可以点击图片、视频、文档、音频等按钮进入对应目录的文件列表浏览界面在文件列表浏览界面点击“”按钮可以添加文件在文件列表浏览界面长按列表项会出现删除图片点击删除图标可以删除文件在图片文件列表界面点击图片可以进入图片预览界面。 工程目录给出项目中关键的目录结构并描述它们的作用示例如下 entry/src/main/ets/
|---Application
|---filemanager
| |---data
| | |---FileDataSource.ets // 懒加载数据格式
| |---pages
| | |---audio
| | | |---AudioFileList.ets // 音频列表页面
| | |---common
| | | |---FileList.ets // 同类型文件列表展示页面接收文件类型展示特定类型的文件列表
| | |---document
| | | |---DocumentFileList.ets // 文档列表页面
| | |---image
| | | |---ImageFileList.ets // 图片列表页面
| | | |---ImagePreview.ets // 图片预览页面
| | |---video
| | | |---VideoFileList.ets // 视频列表页面
| | |---FileManagerHome.ets // 首页主体内容
|---MainAbility
|---pages
| |---index.ets // 首页
Library/src/main/ets/
|---filemanager
| |---components
| | |---ThumbnailImage.ets // 缩略图组件
| |---fileio
| | |---FileIoManager.ts // 文件管理待开发
| |---medialibrary
| | |---MediaLibraryManager.ts // 主要封装了mediaLibrary库相关的接口实现相关功能如对文件的增、删、查和图片预览功能
| |---userfilemanager
| | |---UserFileManager.ts // 封装userFileManager库相关的接口
| |---FileManager.ts // 文件管理接口统一封装了各模块对外提供的功能接口
|---mock // 本地数据
|---utils // 日志工具具体实现 先描述功能都在哪个模块再具体描述如何实现这些功能的以及在哪里使用他们附上文件链接示例如下 增添文件、删除文件、查找指定类型文件文件和预览图片的功能接口封装在MediaLibraryManager源码参考MediaLibraryManager.ts 使用mediaLibrary.getMediaLibrary来获取MediaLibrary对象;读取每个文件的数据使用MediaLibrary.getFileAssets读取满足条件的文件集合FetchFileResult然后调用FetchFileResult.getFirstObject();创建模拟文件使用MediaLibrary.getPublicDirectory()获取系统预定的目录然后使用MediaLibrary.createAsset();删除指定路径的文件使用MediaLibrary.deleteAsset();获取预览图使用image.createImageSource()创建指定的文件资源ImageSource然后调用ImageSource.createPixelMap()接口参考ohos.multimedia.image 。 在Library模块中通过封装FileManager向外提供功能接口如MediaLibraryManager.getPixelMapByFileAsset()源码参考FileManager.ts 如效果预览中的图片列表读取指定类型的文件在FileList.ets 中调用FileManager.getFileAssets()创建模拟文件在FileList.ets 中调用FileManager.createTxtFileAsset()删除指定路径的文件在FileList.ets 中调用FileManager.deleteFileAsset()获取缩略图在ThumbnailImage.ets 中调用FileManager.getThumbnail()如效果预览中的图片预览获取预览图在ImagePreview.ets 中调用FileManager.getPixelMapByFileAsset()。 相关权限介绍应用的使用权限附上链接 依赖 介绍对其他sample的依赖附上sample链接 约束与限制 6.1 支持应用运行的操作系统版本和设备示例如下 本示例仅支持标准系统上运行支持设备RK3568;6.2 API版本、SDK版本如果依赖Full SDK附上替换链接示例如下 本示例仅支持APIXX版本SDK版本号3.X.X.X如果涉及Full SDK还需加上本涉及涉及使用系统接口XXX需要手动替换Full SDK才能编译通过具体操作可参考[替换指南]。6.3 支持的IDE版本示例如下 本示例需要使用DevEco Studio 3.0 Beta4 (Build Version: 3.0.0.992, built on July 14, 2022)才可编译运行6.4 高等级APL特殊签名说明示例如下 本示例涉及[相关权限]为system_basic(或者system_core)级别相关权限级别可通过[权限定义列表]查看需要配置高权限签名可参考[特殊权限配置方法]下载给出单独下载本工程的命令在代码中替换工程目录并以/结尾如下面示例中的 FileManager/FileManager示例如下 如需单独下载本工程执行如下命令 git init
git config core.sparsecheckout true
echo FileManager/FileManager/ .git/info/sparse-checkout
git remote add origin https://gitee.com/openharmony/applications_app_samples.git
git pull origin masterReadMe模板链接
工程结构规范
Sample工程应该区分开场景业务逻辑和特性相关封装接口规则如下
包名命名规则为com.samples.特性名工程名命名规则为特性名称与Readme标题保持一致特性接口封装放在Library模块下能够独立编译成har包复用场景业务逻辑展示Library模块中特性接口的使用放在entry目录中entry/src/main/ets/目录下的pages目录中只放一个Index.ets作为入口页面entry/src/main/ets/目录下创建场景业务目录存放该场景相关的业务逻辑和页面代码Library/src/main/ets/目录下创建特性目录目录下包括components对外开放的控件目录、feature特性封装逻辑目录、Feature.ts对外开放的特性接口等
以FileManager特性为例工程示例结构如下
entry/src/main/ets/ // 场景业务逻辑放在entry目录下
|---Application // 应用级逻辑
|---MainAbility // 元能力组件
|---filemanager // 场景业务功能如果存在多个场景则放在同级目录下
| |---data // 场景业务逻辑相关类或数据
| |---pages // 场景业务逻辑相关页面
|---pages // UI页面
| |---Index.ets // pages下只保留一个Index.ets作为入口页面
|---utils // 共用的工具类或者模块
Library/src/main/ets/ // 特性接口封装放在Library模块下能够独立编译成har包复用
|---filemanager // 特性相关封装类
| |---components // 特性相关UI控件类需要对外开放部分特性涉及对外提供复用UI控件
| | |---FileImage.ets
| |---fileio // 封装了特性相关接口如果存在多个模块放在多个目录下如fileio、medialibrary、userfilemanager不对外开放
| | |---FileIoManager.ts
| |---medialibrary
| |---userfilemanager
| |---FileManager.ts // 对外开放的特性接口无具体实现实现在fileio、medialibrary等模块中
|---mock // 模拟数据
|---utils // 特性相关工具类UI自动化用例编写规范
用例命名规范为“包名_测试功能_序号”如“MyApp_StartAbility_001”序号表示测试StartAbility功能的第1个用例;用例的开头和结尾都需要有日志打印打印必须包括用例名称的关键字用例中每条断言语句前必须添加日志打印参数信息DOMAIN设置为0xF811用例名称中的包名和日志中的包名单独用常量表示方便包名变更整改每条用例前需要添加注释 import hilog from ohos.hilog;...const TAG [Sample_MyApp]const DOMAIN 0xF811const BUNDLE MyApp_.../*** 介绍用例测试的功能和场景等信息*/it(BUNDLE StartAbility_001, function() {hilog.info(DOMAIN, TAG, BUNDLE StartAbility_001, begin)...// 介绍单一步骤的功能hilog.info(DOMAIN, TAG, BUNDLE StartAbility_001, code: code)expect(0).asserEqual(code)...hilog.info(DOMAIN, TAG, BUNDLE StartAbility_001, end)})PR提交格式规范
示例如下
IssueNo: #I56EH7:关联问题
Description: 描述问题.
Sig: sig-systemapplications
Feature or Bugfix: Bugfix
Binary Source: NoSigned-off-by: jiangwensai jiangwensaihuawei.comIssueNo管理issue信息Description描述修改变更内容Sig统一使用SIG_SampleFeature or Bugfix如果是需求选择Feature问题选择BugfixSigned-off-by注明开发者账号和邮箱
