Package org.smoodi.annotation

package org.smoodi.annotation

코드에 대한 문서화를 더 간략히 할 수 있도록 만들어진, 설명에 집중한 어노테이션들의 집합

@Nonnull, @Nullable과 같이, 실제로 코드에 영향을 끼치지는 않으나 다른 개발자들에게 추가적인 보충 설명을 위해 사용 가능한 명시적인 어노테이션들이 포함됨.

  • Annotation Interfaces
    Class
    Description
    Api
    외부 공개 목적으로 사용되는 API임을 표시.
    ForReturn
    반환용으로 사용될 변수임을 표시.
    LazyInit
    지연 로딩으로 초기화되는 변수임을 표시.
    ModifyOriginal
    인자로 받은 원본 객체가 수정됨을 표시.
    NotNull
    null이 아님을 표시.
    Nullable
    null일 수도 있음을 표시.
    NullValue
    null임을 표시.
    Overload
    오버로딩 메소드임을 표시.
    StaticFactoryMethod
    정적 팩토리 메소드임을 표시.
    UseCopy
    원본 대상이 영향을 받지 않도록, 대상을 복사하여 사용 혹은 반환함을 표시.