Java에서 클래스를 변경할 수 없다고 어떻게 주석을 달아야합니까?

나는 최근에 불변의 객체가 얼마나 유용한 지에 대해 비 틀었습니다. 예를 들어 요소를 생성자에 전달하고 클래스가 불변이어야하는 경우, 불변이 아닌 경우 이러한 요소를 복사해야합니다.

프로젝트에 대해 많은 점검이나 지식이 필요합니다.

public A(B foo)

그리고 B, 불변 아닌 A내가 복사해야 할 것이다 B. 이제는 B불변 인 것처럼 보이지만 그 자체에는 생성자 등에서 변경 가능한 클래스가 있습니다.

Java에서 클래스를 변경할 수없는 경우 문서화에 대한 표준 또는 모범 사례가 있습니까? @immutableJavadoc에 키워드 가없는 것 같습니다 .

@Immutable 주석은 완전히 자동 클래스 생성을위한 다른 표준 자바의 일부가 뭔가 것 같다.

String수업 문서를 살펴보십시오 (굵은 글씨는 내가 한 일입니다).

String 클래스는 문자열을 나타냅니다. "abc"와 같은 Java 프로그램의 모든 문자열 리터럴은이 클래스의 인스턴스로 구현됩니다. 문자열은 일정합니다. 값을 만든 후에는 변경할 수 없습니다. 문자열 버퍼는 변경 가능한 문자열을 지원합니다. String 객체는 변경할 수 없으므로 공유 할 수 있습니다.

보시다시피, 특정 레이블 또는 다른 마커는 없지만 클래스를 설명하는 JavaDoc에서 클래스가 String상수의 불변 개체를 나타냅니다.

따라서, 당신의 지침 따라 가정 이 불변 클래스를 생성하는 오라클 자습서를, 클래스의 불변성이 문서화되어 있는지 확인하기 위해, 당신은 단지 당신이 클래스와 무엇을 설명하는의 JavaDoc에 그것에서 언급해야한다 그렇습니다.

그래도 여전히 필요한 내용에 맞지 않으면 여기에서 사용자 정의 JavaDoc 태그를 빌드하는 방법을 살펴볼 수 있습니다 .

주석을 사용할 수 있습니다 :

JSR-305 에서 @ javax.annotation.concurrent.Immutable

또는 실제로 Java 동시성 에서 @ net.jcip.annotations.Immutable