想编写优美的java代码格式要记住这几条规则
做到这些规则的目的很简单,就是写出“优美”的Java代码来。
网站建设哪家好,找创新互联公司!专注于网页设计、网站建设、微信开发、微信小程序开发、集团企业网站建设等服务项目。为回馈新老客户创新互联还提供了金安免费建站欢迎大家使用!
1、Java注释尽可能全面
对于方法的注释应该包含详细的入参和结果说明,有异常抛出的情况也要详细叙述:类的注释应该包含类的功能说明、作者和修改者。
2、多次使用的相同变量最好归纳成常量 多处使用的相同值的变量应该尽量归纳为一个常量,方便日后的维护。
3、尽量少的在循环中执行方法调用 尽量在循环中少做一些可避免的方法调用,这样可以节省方法栈的创建。例如:
for(int i=0;ilist.size();i++){
System.out.println(i);}可以修改为:
for(int i=0,size=list.size();isize;i++){
System.out.println(i);}4、常量的定义可以放到接口中 在Java培训中,接口里只允许存在常量,因此把常量放到接口中声明就可以省去public static final这几个关键词。
5、ArrayList和LinkedList的选择 这个问题比较常见。通常程序员最好能够对list的使用场景做出评估,然后根据特性作出选择。ArrayList底层是使用数组实现的,因此随机读取数据 会比LinkedList快很多,而LinkedList是使用链表实现的,新增和删除数据的速度比ArrayList快不少。
6、String,StringBuffer和StringBuilder 这个问题也比较常见。在进行字符串拼接处理的时候,String通常会产生多个对象,而且将多个值缓存到常量池中。例如:
String a=“a”;
String b=“b”;a=a+b;这种情况下jvm会产生“a”,“b”,“ab”三个对象。而且字符串拼接的性能也很低。因此通常需要做字符串处理的时候尽量采用StringBuffer和StringBuilder来。
7、包装类和基本类型的选择 在代码中,如果可以使用基本数据类型来做局部变量类型的话尽量使用基本数据类型,因为基本类型的变量是存放在栈中的,包装类的变量是在堆中,栈的操作速度比堆快很多。
8、尽早的将不再使用的变量引用赋给null 这样做可以帮助jvm更快的进行内存回收。当然很多人其实对这种做法并不感冒。
C++、C、或者java,这些语言写代码时应该要怎么规范格式,
C/C++源代码书写规范1. 在.h/.cpp的开头应有一段格式统一的说明,内容包括:a. 文件名 (FileName);b. 创建人 (Creator);c. 文件创建时间 (Date);d. 简短说明文件功能、用途 (Comment)。例:////////////////////////////////////////////// FileName: GetVersion.h// Creator: Liu Haifeng// Date: 2002-10-28// Comment: Get file version information////////////////////////////////////////////2.对于主要功能函数应有注释说明。内容包括:功能、入口/出口参数,必要时还可有备注或补充说明,对于函数中的主要功能代码,也应有注释说明。注释以英文为主。例://////////////////////////////////////////////Remarks:// Check file whether exist////Parameters:// LPCTSTR lpszPathName : Input full path name////Return values:// int : Non-zero means success// Zero means failure////////////////////////////////////////////3. 每列代码的长度推荐为80列,最长不得超过120列;折行以对齐为准。例:HANDLE KSOpenFile(const char cszFileName[],int nMode);或者:BOOL KSReadFile(HANDLE hFile,void *pvBuffer,int nReadSize,int *pnReadSize);4. 循环、分支代码,判断条件与执行代码不得在同一行上。例:正确:if (n == -2)n = 1;elsen = 2;不得写做:if (n == -2) n = 1;else n = 2;5. 指针的定义,* 号既可以紧接类型,也可以在变量名之前。例:可写做:int* pnsize;也可写做:int *pnsize;但不得写做:int * pnsize;6. 在类的成员函数内调用非成员函数时,在非成员函数名前必须加上"::"。例:::Sleep(2000);7. 函数入口参数有缺省值时,应注释说明。例:BOOL KSSaveToFile(const char cszFileName[],BOOL bCanReplace /* = TRUE */);或者:BOOL KSSaveToFile(const char cszFileName[],BOOL bCanReplace // = TRUE);8. else if 必须写在一行。9. 与‘{’、‘}’有关的各项规定:9.1‘{’、‘}’应独占一行。在该行内可有注释。例:正确:for (i = 0; i cbLine; i++){ // .....printf("Line %d:", i);printf("%s\n", pFileLines);}不得写做:for (i = 0; i cb; i++){ printf("Line %d:", i);printf("%s\n", pFileLines);}9.2‘{’必须另起一行,‘{’之后的代码必须缩进一个Tab。‘{’与‘}’必须在同一列上。例:正确:if (i 0){m = 1;n++;}不得写做:if (i 0) {m = 1;n++;}例外:if (i == 0){ ASSERT(FALSE); return; }9.3 在循环、分支之后若只有一行代码,虽然可省略‘{’、‘}’,但不推荐这么做。若省略后可能引起歧义,则必须加上‘{’、‘}’。例:正确:if (n == -2)n = 1;elsen = 2;或者:if (n == -2){ n = 1; }else if (n != nTemp){ n = 2; }else{ n = 3; }不得写做:if (n == -2)n = 1;else if (n != nTemp)n = 2;elsen = 3;不推荐:if (i 1){ n = 1; }else{if (i == 1){ n = 2; }else{if (i 1){ n = 3; }}}10. 与空格有关的各项规定。10.1 在所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在‘-’、‘::’、‘.’、‘[’、‘]’等运算符前后,及‘’(取地址)、‘*’(取值)等运算符之后不得有空格。例:正确:int n = 0, nTemp;for (int i = nMinLine; i = nMaxLine; i++)不得写做:int n=0, nTemp;for ( int i=nMinLine; i=nMaxLine; i++ )10.2 for、while、if 等关键词之后应有1个空格,再接‘(’,之后无空格;在结尾的‘)’前不得有空格。例:正确:if (-2 == n)不得写做:if(-2 == n)或if ( -2 == n )等等。10.3 调用函数、宏时,‘(’、‘)’前后不得有空格。例:正确:printf("%d\n", nIndex);不得写做:printf ("%d\n", nIndex);printf( "%d\n", nIndex );等等。10.4 类型强制转换时,‘(’‘)’前后不得有空格例:可写做:(KSFile*)pFile;也可写做:(KSFile *)pFile不得写做:( KSFile* )pFile( KSFile * ) pFile11. 与缩进有关的各项规定11.1 缩进以 Tab 为单位。1 个 Tab 为 4 个空格11.2 下列情况,代码缩进一个 Tab:1. 函数体相对函数名及'{'、'}'。例:int Power(int x){return (x * x);}2. if、else、for、while、do 等之后的代码。3. 一行之内写不下,折行之后的代码,应在合理的位置进行折行。若有 + - * / 等运算符,则运算符应在上一行末尾,而不应在下一行的行首。11.3 下列情况,不必缩进:switch 之后的 case、default。例:switch (nID){case ID_PLAY:......break;case ID_STOP:......break;default:......break;12.对于涉及到系统的功能调用,要求使用系统提供的宏,不得直接使用具体的数值。例: char szSystemPath[MAX_PATH] = {0}; 正确char szSystemPath[260] = {0}; 错误13.关于函数编写的规定13.1 除了非常简单的函数或者没有必要,函数需要有返回值,并且推荐返回值的类型为int,成功时为 true,失败时为false。不推荐直接使用1和0来表示。13.2 在函数内部变量定义全部放在函数的开始处,不能在代码中间出现 变量定义。变量定义需要初始化值,一般是0、false、NULL等。13.3 程序员自行编写的函数不推荐使用DWORD等指明字节长度的变量 类型,推荐使用unsigned long等变量类型。对于ULONG等vc系统定义的变量类型,推荐使用unsigned long 来代替。如果调用系统API,在MSDN中已经指明了是DWORD等类型,则可以使用。13.4 推荐使用int nResult作为函数自身的返回值变量,int nRetCode、BOOL bRetCode作为调用其他函数的返回值变量。13.5 推荐使用goto语句来统一函数出口,goto语句一般只能跳转到一个函数出口,最多只能有两个,出口标识必须命名为Exit0和Exit1。在出口处必须显式检查曾经申请过的系统资源(如内存),并且进行释放。13.6 如果编写DLL,除非特殊情况,导出函数的调用类型必须是__stdcall,便于多模块协同工作。附录:1.函数编写示范///////////////////////////////////////////////////////////////////////// Remarks:// Get file version information//// Parameters:// [in] const char cszPathName : Input file path name// [out] PVERSION_INFO *pVersionInfo : File version information//// Return values:// int : Non-zero means success, zero means failure///////////////////////////////////////////////////////////////////////int GetFileVersion(const char cszPathName, PVERSION_INFO *pVersionInfo){int nResult = false;int nRetCode = false;char szSystemPath[MAX_PATH] = {0};nRetCode = IsFileExist(cszPathname);if (!nRetCode)goto Exit0;//Others code herenResult = true;Exit0:return nResult;}以前你的习惯可能是我定义一个函数,通过传递参数去实现这个函数的功能。面向对象编程要体现三个特点“封装、继承、多态”;比如你写一个飞这个函数,你需要在这里传递参数飞机。换个角度,你定义一个类是飞机,那这个飞机在封装的过程就有飞。降落等这功能(函数)。你想要用飞这个功能(函数)的时候,你只需调用飞机这个类“飞”这个成员函数。
java源程序什么格式
Java程序使用下列文件后缀:
文件类别
文件后缀
Java源文件
.java
Java字节码文件
.class
2.2 常用文件名(CommonFile Names)
常用的文件名包括:
文件名
用途
GNUmakefile
makefiles的首选文件名。我们采用gnumake来创建(build)软件。
README
概述特定目录下所含内容的文件的首选文件名。
3. 文件组织(FileOrgnization)
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读,应该尽量避免。“Java源文件范例”提供了一个页面布局合理的Java程序范例。
名称栏目:java代码书写格式 java格式怎么写
URL分享:http://scpingwu.com/article/dodisds.html