第三次作业----第2题

代码规范

  * 尽量使用完整的英文描述符

  * 采用适用于相关领域的术语

  * 采用大小写混合使名字可读

  * 尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一

  * 避免使用长的名字(小于 15 个字母是个好主意) 类似的名字,或者仅仅是大小写不同的名字

  * 避免使用下划线(除静态常量等)

  * 包(Package) 采用完整的英文描述符,应该都是由小写字母组成。对于全局包,将你的 Internet 域名反转并接上包名。 如:
      java.awt
     com.ambysoft.www.persistence

  * 类(Class) 采用完整的英文描述符,所有单词的第一个字母大写。 如:
      Customer
     SavingsAccount

  * 接口(Interface) 采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。习惯上,名字后面加上后缀 able, ible 或者 er,但这不是必需的。如:
      Contactable
     Prompter

  * 组件/部件(Component) 使用完整的英文描述来说明组件的用途,末端应接上组件类型。 如:
      okButton
      customerList
      fileMenu

  * 异常(Exception) 通常采用字母 e 表示异常。 e

  * 类变量 字段采用完整的英文描述,第一个字母小写,任何中间单词的首字大写,如: firstName
      lastName

  * 实参/参数 同字段/属性的命名规则
      public void setFirstName(String firstName){
            this.firstName = firstName;
     }

  * 局部变量 同字段/属性的命名规则

  ** 获取成员函数 被访问字段名的前面加上前缀 get。 getFirstName(), getLastName()

** 布尔型的获取成员函数 所有的布尔型获取函数必须用单词 is 做前缀。 isPersistent(), isString()

** 设置成员函数 被访问字段名的前面加上前缀 set。 setFirstName(), setLastName(),setWarpSpeed()

** 普通成员函数 采用完整的英文描述说明成员函数功能,第一个单词尽可能采用一个生动的动词,第一个字母小写。 openFile(), addAccount()

* 静态常量字段(static final) 全部采用大写字母,单词之间用下划线分隔。 MIN_BALANCE, DEFAULT_DATE
    
    * 循环计数器 通常采用字母 i,j,k 或者 counter 都可以接受。 i, j, k, counter

* 数组 数组应该总是用下面的方式来命名: byte[] buffer;

  * 注释应该增加代码的清晰度

  * 保持注释的简洁

  * 在写代码之前写注释

  * 注释出为什么做了一些事,而不仅仅是做了什么

  

所有的 Java(*.java) 文件都必须遵守如下的样式规则:

  1) 版权信息

  版权信息必须在 java 文件的开头,比如:

  /**
    * Copyright @ 2000 Shanghai XXX Co. Ltd.
    * All right reserved.
    * @author: gcgmh
    * date: 2008-12-22
    */

  其他不需要出现在 javadoc 的信息也可以包含在这里。

  2) Package/Imports

  package 行要在 import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理。

  package hotlava.net.stats;
    
     import java.io.*;
     import java.util.Observable;
     import hotlava.util.Application;
  这里 java.io.* 是用来代替InputStream and OutputStream 的。

  3) Class

  接下来的是类的注释,一般是用来解释类的。

  /**
   * A class representing a set of packet and byte counters
   * It is observable to allow it to be watched, but only
   * reports changes when the current set is complete
   */

  接下来是类定义,包含了在不同的行的 extends 和 implements
  public class CounterSet extends Observable implements Cloneable{
        ……
         ……
    }
   
   4) Class Fields

  接下来是类的成员变量:

  /**
    * Packet counters
    */
    protected int[] packets;

  public的成员变量必须生成文档(JavaDoc)。proceted、private和 package 定义的成员变量如果名字含义明确的话,可以没有注释。

  5) 存取方法(类的设置与获取成员函数)

  接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话,可以简单的写在一行上,如类的成员变量已经有注释,类变量的存取方法可以没有注释。

  public int[] getPackets() { return this.packets; }
   public void setPackets(int[] packets) { this.packets = packets; }
     ……

  要求说明的是,对于集合,加入成员函数来插入和删除项;另其它的方法不要写在一行上。

  6) 构造函数

  接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面)。

  public CounterSet(int size){ this.size = size;}

  7) 克隆方法

  如果这个类是可以被克隆的,那么下一步就是 clone 方法:

  public Object clone() { try { …… }catch(CloneNotSupportedException e) { …… }}

  8) 类方法 (类的普通成员函数)

  下面开始写类的方法:

  /**
   * Set the packet counters
   * param r1 - ……
   * param r2 - ……
   * ……
   */
  protected final void setArray(int[] r1, int[] r2, int[] r3, int[] r4) throws IllegalArgumentException{
   // Ensure the arrays are of equal size
   ……
  }

9) toString 方法

  一般情况下,每一个类都应该定义 toString 方法:

  public String toString() { ……}

  10) main 方法

  普通类,考虑置入一个main()方法,其中包含用于测试那个类的代码,如果包含了main() 方法, 那么它应该写在类的底部。

时间: 2024-11-05 09:21:46

第三次作业----第2题的相关文章

第三次作业第四题

根据邹欣老师的教材相关内容,确定小组成员的角色,细化项目需求.时间计划.列出产品积压工作项和预计开发时间 一.小组成员分工明细如下: 二.细化项目需求: 项目需求说明书已在上周完成,github上需求文档的链接如下 https://github.com/vrfighter/Arithmetic/blob/master/document/%E5%9B%9B%E5%88%99%E8%BF%90%E7%AE%97%E9%9C%80%E6%B1%82%E6%8A%A5%E5%91%8A.md 三.项目预

第三次作业第一题

问卷调查 看到一个问卷不错,拟作为第三次作业的部分内容. 1.   你对自己的未来有什么规划?做了哪些准备 答: 我对未来的规划是想做网页设计类的  目前的准备是多看相关知识的书,熟悉网页设计的软件认真学习,将自己所学运用到实际工作中. 2.   你认为什么是学习?学习有什么用?现在学习动力如何?为什么? 答:学习就是把不会的知识变成会的.学习的作用是学会了就能运用到实践中.现在的学习动力还没有那么努力因为可能是还是找不到自己的目标比较迷茫 3.   你感觉自己什么事情做的比较成功?有什么经验?

解题报告——-2018级2016第二学期第三周作业

解题报告——2018级2016第二学期第三周作业 A:[NOIP2002P]过河卒 题目: 描述 如图,A 点有一个过河卒,需要走到目标 B   点.卒行走规则:可以向下.或者向右.同时在棋盘上的任一点有一个对方的马(如上图的C点),该马所在的点和所有跳跃一步可达的点称为对方马的控制点.例 如上图 C  点上的马可以控制 9 个点(图中的P1,P2 … P8 和 C).卒不能通过对方马的控制点. 棋盘用坐标表示,A 点(0,0).B 点(n,m)(n,m 为不超过 20  的整数,并由键盘输入)

职业规划第三次作业

看到一个问卷不错,拟作为第三次作业的部分内容. 你对自己的未来有什么规划?做了哪些准备? 答: 学好大学四年的课程,并积极参加各种活动来锻炼自己的能力.在实习期间认真学习工作经验,学习经验然后争取能自己创业 好好交友,多读书, 你认为什么是学习?学习有什么用?现在学习动力如何?为什么? 答:学习是通过他人的言传身教了解知识,将他人的认识转化为自己的知识.学习能够取他人之长补己之短,丰富自己的认知,还避免了闭门造车和坐井观天的错误.现在的学习动力一般,因为新学知识对我来说比较陌生. 你感觉自己什么

o(︶︿︶)o 唉,第三次作业

                                                                             第三次作业 1.需求分析 (1)从combox控件中,获取各种运算(+.=.*./),用户可以输入运算范围,比如想算0-10以内的,那么就在textbox5和6中输入0和10就行,当然,如果5中的数字比6中的数字小的话,会有消息提示框,并清空他们.用户可以选择算法,设置范围后,点击计算,输入结果,回车就可以. 2.设计思路 (1)思考应该怎么做

第三次作业(毛涛和徐明艳)

第三次作业 题目: 请编写一个能自动生成小学四则运算题目的“软件”.让程序能接受用户输入答案,并判定对错.最后给出总共对/错的数量. 需求分析:      1. 该软件是针对学生有限的计算能力,计算效率,计算精确度而制作的软件: 2. 该软件可以进行简单的四则运算并进行判断: 扩展功能: 1. 程序可以出带括号的正整数四则运算,支持分数,除法保留两位小数. 2. 可以出表达式里含有负整数(负整数最小不小于-100)的题目,且负数需要带括号,用户输入的结果不用带括号. 设计:  根据四则运算法则本

面向对象第三次作业

本次实验要求于2015年10月18日(含)之前完成并以一个文本文档(记录第一题答案)和一个cpp文件(第二题程序)发送到[email protected]邮箱中(不用压缩,共两个附件),邮件主题为"学号姓名第三次作业" 一.运行第二次作业程序10000次,然后回答下列问题: (1)该游戏赢的机会有多少? (2)投骰子游戏平均长度是多少(即平均投多少次骰子)? (3)游戏玩的越久,赢的机会是否越多?为什么? (4)在这10000次中,两个骰子点数的和出现最多和最少的是什么? 二.修改第二

第三次作业-徐镇、尚清丽

 —— 题目:           请编写一个能自动生成小学四则运算题目的 “软件”.           让程序能接受用户输入答案,并判定对错.           最后给出总共 对/错 的数量. ——需求分析: 此“软件”主要面向小学生,考虑到小学生对计算机的使用和掌握程度有限,所以此“软件”的操作应尽量简单,易使用: 用户能在此"软件"上练习简单的四则运算: 此“软件”能提交用户的答案,并判断对错: 在使用此 “软件”后及时给出正确与错误的题目数. ——基本功能要求: 对于该题目

第二次作业电梯编程题测试结果

第二次作业电梯编程题测试结果 电梯作业中出现的问题 最终需要输出的是乘客等待时间和(不是电梯运行时间) 部分同学的代码对非按序排序的时间无法处理 代码文件的命名最好不要有中文.空格 不要在代码末尾加 system("pause") 完整代码要求上传到github,博客中若需要贴代码只贴关键代码即可 表格中测试结果负分的含义 仓库无代码文件 No Source Code File -1 对输入的测试用例不能运行 Runtime Error -2 能运行但无法输出结果 No Output