项目开发相关规范
2023-09-11 14:20:46 时间
文件夹规范
文件夹规范——在开发中总体文件夹组织结构。
1.Requirement——需求文档目录
2.Design——设计文档目录
3.Test——集成測试,系统測试,測试报告。測试清单目录
4.Deployment——公布部署的目录
5.Study——预研。学习资料的目录
6.Src——源代码目录
7.Help——帮助文档目录
基本命名规范
1.变量使用驼峰法的规则命名,要增加前缀m,如:mUserNum;
2.常量使用全大写字母标识。单词间用下划线隔开,如:USER_NAME;
3.类名使用首字母大写,如:UserName;
4.方法名使用驼峰法的规则命名。不用增加前缀。如:getUserName;
5.接口名使用首字母大写;
包名命名规范
1.包名一律首字母大写, 少用缩写;
2.包名结构:[项目名].[基本模块名].[详细模块名]
如:com.example.View.UserModule
凝视
文件,类或接口凝视
Ÿ全部的源文件都应该在开头有一个凝视,当中列出文件的作者、时间、功能描写叙述以及创建、改动记录
/**
*
* @Description功能描写叙述
*
* 版本 作者 日期 相关改动
* 1.0 linbin 2014-5-4 创建
*
* @author linbin
*2014-5-4
*/
方法凝视
Ÿ全部的方法都应该在开头有一个凝视,当中列出功能描写叙述,所使用的參数说明,返回值说明
/**
* 功能描写叙述
* @param參数说明
* @return返回值说明
*/
凝视格式设置方法:
右键项目->Properties->Java CodeStyle->Comments 然后选择相应项,进行模板的设置
相关文章
- 自然语言交流系统 phxnet团队 创新实训 项目博客 (十四)
- 第二章 Hibernate项目开发过程
- win8 开发之旅(2) --连连看游戏开发 项目错误的总结
- 《转载》IntelliJ 2016.2 IDEA 中进行 Java Web 项目开发配置
- nginx配置80端口访问8080+项目名地址
- vue卸载与安装+vue创建项目
- android开发学习---基础知识学习、如何导入已有项目和开发一个电话拨号器
- [APP] Android 开发笔记 001-环境搭建与命令行创建项目
- Swift项目开发实战-基于分层架构的多版本iPhone计算器-直播公开课
- Qt编写的项目作品24-人脸识别综合应用(在线+离线+嵌入式)
- 为.NET Core项目定义Item Template
- JSP项目报错在build path里找不到javax.servlet.http.HttpServlet的解决方法
- Atitit 项目中的勋章体系,,mvp建设 ,荣典体系建设
- 参加 Spartacus 开源项目开发时需要注意的一些编程规范
- 效率提升总结-Unity 项目规范文档 【建议收藏】
- 作为一个上班族,有哪些Python兼职项目?兼顾练手和创收?
- 【华为云实战开发】10.经典的C++项目怎么在云端开发?
- [手游新项目历程]-48-svn分支开发与主干合并
- 第3章 类型系统与可空类型 《Kotlin项目实战开发》
- 《Kotlin项目实战开发》第5章 函数与函数式编程
- 使用Jquery+EasyUI 进行框架项目开发案例解说之二---用户管理源代码分享
- 项目之开发模式
- RK3399平台开发系列讲解(项目实践篇)1.8、嵌入式开发都可以理解的卷积网络(简单明了无公式)
- RK3399平台开发系列讲解(项目实践篇)1.11、ISP+ARM的摄像头数据处理系统方案
- 如何把 Kitten编程猫上开发出来的项目打包成安卓平台上可以安装的apk文件
- 【Web开发】Vue+Springboot项目服务器部署(环境搭建+部署流程)
- 推荐一款YYDS的低代码开源项目:1小时创建企业专属ERP