ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • doxygen용 이클립스 code templates 정리
    Programming/JAVA 2014. 2. 18. 13:48


    일단 다운받자.


    // 코드 템플릿

    주석 입력 단축키 [Alt + Shift + J]

    140218_kss_codetemplates_for_doexygen (2).xml



    // doxy file

    EnvironmentMonitor2.doxyfile




    "이클립스 > Window > preferenes > Java > Code Style > Code Templates > Import " 위의 파일 Import.



    - 주석은 두가지 스타일..

    /// 

    /**  */


    - Doxygen페이지에 표시될 부분을 코드형태로 지원

    @author 작성자 이름

    @brief 간략한 설명 
    @bug   
    @code 중요 코드를 설명할 때 시작 지점 설정 

    @endcode 중요코드 설명할 때 종료 지점 설정

    @date 작성날짜

    @enum 
    @exception 예외 처리 
    @file 파일 이름을 구별 
    @fn 함수이름을 구별

    @mainpage 메인페이지 설명

    @param 함수 파라미터 표시 
    @remark 자세한 설명 및 주의 사항에 관하여 기재
    @return 함수의 리턴 값을 나타낼 때 
    @section 페이지 내용에서 font를 크게 보여줌
    @see 참고할 함수나 페이지 설명
    @struct 구조체 정의 
    @todo 다음에 작업 해야할 내용 기재 
    @version 버전




    이클립스 Code Templates 설명.



    - files

    /////////////////////////////////////////////

    /// @file ${file_name}

    /// @section 파일생성정보

    ///    |    항  목       |      내  용       |

    ///    | :-------------: | -------------   |

    ///    | File name | ${file_name} |    

    ///    | Package | ${package_name} |    

    ///    | Project name | ${project_name} |    

    ///    | Type name | ${type_name} |    

    ///    | Company | DGIST | 

    ///    | Create Date | ${year} ${date} ${time} |

    ///    | Author | ${user} |

    ///    | File Version | v1.0 |

    ///    | Other.. | ... |

    /////////////////////////////////////////////


    1. @file : doxygen에게 file 에 대한 주석인것을 명시

    2. ${file_name} : 이클립스 에서 파일생성시 자동으로 주석이 추가되며, 해당 filename을 자동으로 삽입

    3. @section 파일정보 : 파일정보라는 글자를 크게 보여주고 섹션을 나눔

    4. 위와같이 표기하면 doxygen상에서 테이블을 그려준다.     

    | :---  | // 좌측 정렬   

    | :---: | // 가운데정렬 

    |  ---: | // 우측 정렬

    5. ${} 로 표기되는 코드들은 이클립스 툴에서 자동으로 해당내용을 삽입해준다.








    - Types

    /////////////////////////////////////////////

    /// @class ${type_name}

    ///${package_name} \n

    ///   ㄴ ${file_name}

    /// @section 클래스작성정보

    ///    |    항  목       |      내  용       |

    ///    | :-------------: | -------------   |

    ///    | Company | DGIST |    

    ///    | Author | ${user} |

    ///    | Date | ${date} ${time} |

    ///    | Class Version | v1.0 |

    ///    | 작업자 | ${user}, Others... |

    /// @section 상세설명

    /// - 이 클래스는...

    ///   -# 첫번째 설명

    /////////////////////////////////////////////


    1. @class : doxygen에게 class 에 대한 주석인것을 명시






    - Methods

    /////////////////////////////////////////////

    /// @fn ${enclosing_method}

    /// @brief 함수 간략한 설명 : 

    /// @remark

    /// - 함수의 상세 설명 : 

    /// ${tags} 

    ///

    ///~~~~~~~~~~~~~{.java}

    /// // 핵심코드

    ///~~~~~~~~~~~~~

    /////////////////////////////////////////////



    ///~~~~~~~~~~~~~{.java}

    /// // 핵심코드

    ///~~~~~~~~~~~~~

    위와 같은 형태 내부에 코드를 삽입하면, 코드 블럭이 형성되어서 페이지에 삽입된다.

    인터넷에 보니 라인넘버도 나오고 하던데.. 잘 안되네..

    그리고 주석형태가 아닌 Real코드를 바로 삽입하는 방법은 없나... 조금 불편하다.








    - Constructors

    /////////////////////////////////////////////

    /// @fn 

    /// @brief 생성자 간략 설명 : 

    /// @remark

    /// - 생성자 상세 설명 : 

    /// ${tags} 

    ///~~~~~~~~~~~~~{.java}

    /// // 핵심코드

    ///~~~~~~~~~~~~~

    /////////////////////////////////////////////




    - Overriding methods

    /////////////////////////////////////////////

    /// @fn 

    /// @brief (Override method) 함수 간략한 설명

    /// @remark

    /// - 오버라이드 함수의 상세 설명

    /// ${see_to_overridden}

    /////////////////////////////////////////////



    - Getter

    /////////////////////////////////////////////

    /// @fn ${field_type} ${enclosing_method}()

    /// @brief date:${year} ${date} user:${user}

    /// @return the ${bare_field_name} get

    /////////////////////////////////////////////



    - Setter

    /////////////////////////////////////////////

    /// @fn void ${enclosing_method}(${field_type} ${field})

    /// @brief date:${year} ${date} user:${user}

    /// @param ${param} the ${bare_field_name} to set

    /////////////////////////////////////////////




    나머지는 그닥 설명이 필요없어서 생략.


    자세한 내용은 (http://www.stack.nl/~dimitri/doxygen/manual/index.html) 메뉴얼 참고



    댓글

Designed by Tistory.