[Android] 패키지(Package) 주석 달기

JavaDoc을 활용하기 위해 package-info.java에 주석을 넣으려고 시도하였으나 Android Studio에서는 찾아볼 수 없었습니다.

선언은 되어 있으나 찾지 못한 package-info.java 

이 이슈에 대해서 이미 고민하신 분이 계셨습니다.

https://www.intertech.com/Blog/whats-package-info-java-for/

간단히 요약하자면,

단순히 패키지쪽에서 강제로 package-info.java 로 File을 생성하여 그 안에 패키지 이름을 넣고 주석을 넣어주면 됩니다.

정리

패키지 주석에 대해서 알아봤습니다.  JavaDoc에서 패키지 주석도 추가하여 좀 더 친절한(?) 문서를 제공해 줄 수 있습니다.

[패키지(Package) 주석]

1. 패키지(package)에 package-info.java 이름으로 파일 생성

2. package-info.java 에서 패키지(package) 이름과 주석을 넣어줍니다.

/**

 * //package detail

 */

package com.package.name;