程序命名规则
提示:模块设计人员确定本软件的模块命名规则(例如类、函数、变量等),确保模块设计文档的风格与代码的风格保持一致。可以从机构的编程规范中摘取或引用(如果存在的话)。
命名规则
1、包命名
Java程序以包名为文件目录名,通过包的分层结构实现对程序进行归类和模块化管理。包名要求全部用英文字母小写,通过.进行分割,建议在包名中体现公司名称或产品(项目)英文名简写,通常为“公司名+产品(项目)名+模块名+子模块名”,如:ausware.apply.manage(ausware为公司英文名,apply为产品名,manage为模块名),商业软件通常会以com.开头,如:com.sun.java.swing(com为通用前缀,sun为公司名称,java为产品名,swing为模块名),是否加com不做强制要求。
2、类命名
Java中类名统一要求用英文单词或组合,可以用简写,单词首字母要大写,单词之间通过大写字母隔开。类名应该准确表达本类的作用,通常为“模块名+功能名”结构,如:EngineManage,DeviceAction。
3、类成员变量命名
操作类成员变量要求以m_打头;如果变量为全局变量,以g_打头;数据结构类成员不建议用m_开头。
变量需要明确表达含义,采用英文单词或组合,可以用简写,用大写字母隔开,除了范围字母,首字母小写。通常为“范围+类型+变量描述”,其中常见的类型主要有:map(表示映射集HashMap、Map)、vec(表示向量集Vector)、list(表示List)、b(表示boolean)、i(表示int)、str(表示String,由于String类型在java中非常常用,通常可以不用str开头,以免累赘)、l(表示long)、c(表示char)、f(表示float)、d(表示double)。举例:
操作类:
public class EngineManage
{
private static EngineManage g_instance=null; //全局
private HashMap<Long,EngineContext> m_mapEngineContexts=new HashMap(); //成员
private boolean m_bInitFlag = false; //成员,是否初始化标志
public int m_iPort = 0;
public long m_lSize = 0;
}
数据结构类:
public class DeviceModel
{
public String devNameAlias = null; //设备别名
public String devName = null; //设备名称
public float fSize = 0;
public double dWideSize = 0;
}
4、类成员函数命名
类成员函数名需要表达出函数功能,采用英文单词或组合,可以用简写,首字母小写,中间单词的首字母要大写,其余小写。第一个单词为动作,后续单词为作用对象,通常为:“动作+对象名”,举例:createEngineContext,addDevice。
5、函数参数名
采用英文单词或组合,可以用简写,首字母小写,中间单词采用大写字母隔开。不要用m_和g_开头。
对于接口函数的参数名,建议尽量明确表达出参数是输入、输出、输入及输出,以及类型。输入通常用in,输出通常用o,输入输出通常用io,举例:
public long createEngineContext(String engineContextClassName,RefString oErrMsg);
接口函数:
public int retriveDatas (String inStrID ,Vector oVecDatas, RefString oErrMsg);
// inStrID 中的in为输入,Str为类型,ID为变量描述;
// oVecDatas 中的o为输出,Vec为类型,Datas为变量描述;
//oErrMsg中的o为输出,ErrMsg为变量描述。
6、函数内部变量名
原则上除了计数变量i,n,k,j等,都应该采用英文单词或组合表达明确含义,可以用简写,不要用m_和g_等开头。普通变量通常为“类型+变量描述”;对复合自定义对象的命名可以直接用对象名,把首字母改为小写;需要返回的变量建议加上ret前缀;临时变量建议加上tmp前缀。举例:
for(int i; i<10; i++); //计数变量
boolean bSearchFlag; //以类型为前缀
int iSize;
long lWidth;
String strDevName; //带String类型前缀str
String devName; //不带String类型前缀,因String非常常用可以省略
EngineContext engineContext = null; //复合自定义对象,用类型名,把首字母改为小写
EngineContext tmpEngineContext = null; //带临时变量tmp前缀
EngineContext retEngineContext = null; //带返回变量前缀ret
7、常量名
常量名采用大写单词或以下划线_组合多个单词,明确表达含义,如:
public final static String YES = "yes";
public final static int DEBUG_ERROR = 2; //记录出错信息
public final static String SYSLOG_PROCESS_NAME = "SYSLOG";
大家的Android项目包命名规则是怎样的
Posted
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了大家的Android项目包命名规则是怎样的相关的知识,希望对你有一定的参考价值。
参考技术A android studio软件怎么重命名文件包名?重命名文件包名很有可能会导致程序编译错误的问题发生,但是很多情况下程序开发者都有可能会需要对程序进行重命名的操作,如何操作才能使android studio软件正确重命名呢?下面为大家整理了几种方法,其中第二种最好用,大家可以看看。 android studio软件中重命名快捷键: shift+F6:可对类、方法、变量进行重命名 android studio软件重命名文件包名方法一: 首先创建一个新的软件包所需的名字通过右键点击文件夹->新建-> Java包 然后,选择并拖动你的所有类的新方案。androidstudio将重构包名随处可见。 最后,删除旧的包。 android studio软件重命名文件包名方法二: 比如 我们需要把 package="com.studyplayer.english" 这样 我们就可以在同一台机子上安装这两个APK了 因为他们的包名已经不一样了 但是我们需要修改的地方不只是这一处,还有原文件夹名也要修改 在我们先修改了AndroidManifest.xml 中的名字之后 会发现文件中凡是有用到R文件的地方都会报错 其实这个就非常简单了 右键点击上图中 "chinese"的那个包 这样子基本上就所有的报错信息都消失了 clean一遍 然后重新编译 就OK了 Eclipse和Android Studio都提供了自动修改包名的工具,Android Studio在选中包名后,使用快捷键 shift+(Fn+)F6 或者选中菜单 Refactor-》Rename 进行重命名。 不要选中下面提供的两个选项,重命名后,我们还需要 手动修改AndroidManifest.xml 文件 修改的工作理论上已经完成, clean下项目,运行!如果此时出现错误,【内容中还包含之前包名的信息】 , Android studio无法使用F2的方式直接重新命名。 android studio软件重命名文件包名方法三: 1、进行打开电脑中已经安装好的Android studio的应用程序,并在在Android studio中加载项目的文件。 2、选中完项目之后,进入到项目中找到需要重新命名的文件。 3、然后就可以点击Android studio菜单中列表中的Refactor的选项。 4、这样就会弹出了一个下拉菜单中选项,进行选择下拉菜单中的“rename”的选项。 5、弹出rename的选项框,在输入框中输入需要重新的命名的名称。 6、可以看到了该的文件名称被重新命名成功了。 总结:以上就是小编为大家带来的所有android studio软件怎么重命名文件包名的相关内容,不知道大家是否都熟悉了呢? 小编推荐: Android Studio手动安装Genymotion插件方法 android studio导出文件设置为html格式方法 android studio 怎么回退项目版本?java 程序命名规则
以上是关于大家的Android项目包命名规则是怎样的的主要内容,如果未能解决你的问题,请参考以下文章