java程序开发中需要写入代码的“注释”

java程序开发中需要写入代码的“注释”

严格来讲不能是注释，只不过我想不到应该用一个什么词汇来概括它们，所以就滥用这个词了QwQ

1.对于类而言，需要撰写RI(rep不变量)、AF（抽象函数）、Safety from rep explosure（防止泄露）
样例：写一个分数ADT，实际rep为两个整数

//RI
//b！=0

//AF
//AF(a,b)=a/b

//Safety from rep explosure
//所有字段皆为private
//防御式拷贝（需要具体写出哪里使用了防御性拷贝）

2.对于方法而言，需要撰写spec，包括param（参数）、return（返回值）、throws（异常）
对于一个方法而言spec是相当重要的，一目了然，我们就能知道该方法的功能

/**创建一个停车场实例
*param name 停车场名称，长度大于0，不为空
*param lotsNumber 该停车场车位数，大于等于5
*param numbers 所有停车位编号列表，长度与lotsNumber相同
*param widths 所有停车位宽度列表，长度与lotsNumber相同
*return 一个名字为name，有lotsNumber个车位，且每个车位都有编号和宽度的停车场实例
*throws 当某某异常时，抛出Exception

在判断是否符合LSP中，我们经常看到如下“注释”：

abstract class Vehicle {//父类
	int speed, limit;
	//@ invariant speed < limit;
	//@ requires speed != 0;
	//@ ensures speed < \old(speed)
	void brake();
}
class Car extends Vehicle {//子类
	int fuel;
	boolean engineOn;
	//@ invariant speed < limit;
	//@ invariant fuel >= 0;
	//@ requires fuel > 0 && !engineOn;
	//@ ensures engineOn;
	void start() { … }
	void accelerate() { … }
	//@ requires speed != 0;
	//@ ensures speed < \old(speed)
	void brake() { … }
}

其中，
invariant：不变量
requires：前置条件
ensures：后置条件
对于LSP，有这样的约定：

1. Subtypes can add, but not remove methods 子类型可以增加方法，但不可删

2. Concrete class must implement all undefined methods 子类型需要实现抽象类型中的所有未实现方法

3. Overriding method must return same type or subtype 子类型中重写的方法必须有相同类型的返回值或者符合co-variance的返回值

4. Overriding method must accept the same parameter types 子类型中重写的方法必须使用同样类型的参数或者符合contra-variance的参数

5. –Overriding method may not throw additional exceptions 子类型中重写的方法不能抛出额外的异常，抛出相同或者符合co-variance的异常

Also applies to specified behavior (methods):
– Same or stronger invariants 更强的不变量
– Same or weaker preconditions 更弱的前置条件
– Same or stronger postconditions 更强的后置条件

父类型→子类型：越来越具体specific
返回值类型：不变或变得更具体
异常的类型：也是如此
参数类型：要相反的变化，要不变或越来越抽象