jar로 된 제 게임엔진을 넣고, 메소드 이름을 쓰면 저런 창이 나와서 설명을 볼 수 있게 해주고 싶은데요.
javadoc이나 doxygen을 쓰면 되는건지, 해봐도 잘 안되고요.
뭘 쓰면 저런걸 만들 수 있나요? 가르쳐주세요~ ㅠㅠ
/**
* TSGameFramework - TSGLGame
* <a href="http://www./">TSGLGameProject</a>.
* @param GLGraphic - This is
*/
public ~~~~~~~~
이런식으로 주석을 메서드 위에 붙여서 다시면 저렇게 이쁘게 나와요^^
링크거는 방법도 적어두었어요
@ << 하시고 어시스트 쓰시면 여러가지 나와요^^
이쁘고 좋은 엔진 개발 부탁드려요^^ 파이팅
Project Explorer 에서 해당 jar 파일 선택 -> 우클릭 -> Properties -> Javadoc Location 에서 설정하시면 됩니다.
주석 넣을 때
/**
주석문
*/
넣으시면 되고요
위의 함수를 예시로 들면
/**
* 현재 위치 값을 리턴합니다.
* @return 현재 위치 값
*/
public int getCurrentPosition(){
return position;
}
왠만한건 이클립스로 주석문 만드실때 /** + 엔터 + */ 쓰시면 다 자동으로 만들어져요
자바 컨버전 문서 한번 봐보세요 ^^
했는데요.
Exception 처리된 함수는 나오질 않더라고요.
@throw 넣어야 한다고 해서 넣어도 안나오고 답답하네요.
다른 함수들은 잘 나옵니다.
/**
* 읽기 가능한 DB 불러오기
*
* @return 데이터베이스
* @throws SQLiteException
* 불려지는게 실패할 경우 에러로 던짐
*/
public SQLiteDatabase getReadableDB() throws SQLiteException {
SubScriptDBOpenHelper openHelper = new SubScriptDBOpenHelper(mContext);
return openHelper.getReadableDatabase();
}
제가 만든 주석문입니다.
@throws 예외클래스 설명
이렇게 적으면 되고요
위는 저희 회사 부서에서 사용하는 컨벤션이라서 그런거니 신경스지 마세요 ㅡ.ㅡa
읭? 저 엔진은 jar로 class파일이되어 배포되어 사용자들이 봐야하는데..
코드상에서 /** asdsadkljhafasdf */ 이걸로 나온다고요??
제가 알기론 html로 javadoc문서 만들어서 배포해야하는 걸로 알고있습니다요.
아닌가요?
으으.....
저도 api레벨이나 링크같은거 까진 할 줄 모르고
메서드 위에다가 /** 하고 엔터 탁 치면
뭔가 주석 양식이 주르륵 달리는데 거기 쓰는걸로 만족합니다 ㅠㅠ