JAVA随堂笔记课【一】：命名规范

题记：

1. 作为初学者使用的都是Eclipse，故短期内都会以此为例。变更再做说明。
2. 本次使用的版本为默认版本jre1.8.0_60，以后不做特别说明均参考此条
   

课堂笔记：

项目命名格式(JPA-Project)

• 所有单词的第一个字母全部大写（包括首字母）

  ProjectFirstClass
  JavaTraining

项目包命名方式(package)

1. 所有字符小写，不能有中文字符
2. 不能有下划线和其它非数字和字母的符号

3. 域名倒装

   package edu.fzu.zc.training;
   package stu355.note.listen;
   

类名规范

1. 英语命名+首字母大写。不要用下划线（那是c++）

2. 定语+名词结构。不能是动词。

   public class PrimeWork{
       ......
   }
   

属性规范

1. 英语命名+首字母小写。驼峰格式。不要用下划线（那是c++）

2. 定语+名词结构。不能是动词。

   public class primeWork{
       int userAccount;
   }
   

方法规范

1. 英语命名，首字母小写，后续新单词首字母大写，符合驼峰命名法 ，不要用下划线来分割单词。

2. 动宾结构，不能是名词，比如 doSomething,playgame,gohome,doIt,setButtons…如果是boolean类型返回值，一般用疑问句心态，比如:isXXX?

   private static boolean isPrime(int x){
       ......
   }
   private static void onButtonClick(.....){
       ......
   }
   

编码技巧

1. TDD开发模式 (Test-Driven-Development)
   
   • 就是测试-驱动-研发。
   • 通俗来说就是一个阶段代码写完停一停，加两个例子测试下，测试没有问题再写下一个代码。这样就能有效预防出错还找不到在哪的情况。
2. 模块化开发模式（统一接口）

合理注释

/* 这是c语言风格多行注释 */
// 这是c++风格单行注释

在eclipse中执行键位"/**回车"会得到文档专用注释。非常常用的注释。

    /** * 素数判断程序isPrime。 * @param x * @return true: is a rime, false: is not a prime. */
    public static boolean isPrime(int x){
        if (x < 2) return false;
        for(int i=2;i<=Math.sqrt(x);i++)
            if (x%i == 0) return false;
        return true;
    }

快捷键小记

eclipse中使用ctrl+shift+O可以自动导入（import）当前变量相关联的包，超级方便。
比如在主程序中开启文本扫描类

Scanner scanner = new Scanner(System.in);

此时在当前行ctrl+shift+O，代码顶端如果没有导入相关的包，会自动导入此包。

import java.util.Scanner;

课堂代码：判断素数

package stu355.note.listen;

import java.util.Scanner;

/** * PrimeWork素数判断公式 * 输入两个数，判断从a到b是否为素数， * 每累计到8个素数换行一次，最后会输出a到b所有素数总和。 * * @author Moso31 */
public class PrimeWork {

    /** * 素数判断程序isPrime。 * @param x * @return true: is a rime, false: is not a prime. */
    public static boolean isPrime(int x){
        if (x < 2) return false;
        for(int i=2;i<=Math.sqrt(x);i++)
            if (x%i == 0) return false;
        return true;
    }

    public static void main(String args[]){
        Scanner scanner = new Scanner(System.in);
        int begin, end;
        begin = scanner.nextInt();
        end = scanner.nextInt();

        int count = 0;
        int sum = 0;
        for(int i=begin;i<=end;i++){
            if (isPrime(i)){
                System.out.print(i + "\t");
                count++;
                sum+=i;
                if (count % 8 == 0)
                    System.out.println();
            }
        }
        System.out.println("\nsum is: " + sum); 
    }
}

导出成文档：

在eclipse中点击File->Export…
在搜索栏中输入javadoc
javadoc command应选择自己系统盘内javadoc.exe的地址。我的长这样：

C:\Program Files (x86)\Java\jdk1.8.0_66\bin\javadoc.exe

create Javadoc for members with visibility:
从左往右一级比一级开放。最右边只有public成员被编写文档，而到最左边所有的成员（包括private）都会被编写文档。当然，有的时候一个APP并不需要向公众开放所有类。不过这次这么小的就无所谓……
然后选择yestoall

然后就可以直接访问了！是一个html的API文档。

file:///C:/Users/Moso31/workspace/JavaTraining/doc/index.html

OK，到此本课结束。