현재 위치

홈 ›› Forums ›› 공부 ›› 프로그래밍 QnA

여러분들은 여러분의 프로그램의 api 도큐먼트를 어떤식으로 만

acidd15의 이미지
글쓴이: acidd15 / 작성시간: 월, 2005/05/23 - 10:40오전

여러분들은 여러분의 프로그램의 api 도큐먼트를 어떤식으로 만드시나요?

고민에 빠졌습니다.그냥 하드 코딩 하자니 빡시고...툴을 이용하자니 간단한 문법을 가진게 눈에 안띄네요.일전에 docbook을 좀 고려해 보긴했었습니다만...역시나 좀 --;;

어쩌면 그런거 뭐하러 만드냐는 분도 있을듯 --;;

Forums: 
프로그래밍 QnA
litdream의 이미지

글쓴이: litdream / 작성시간: 월, 2005/05/23 - 11:20오전

doxygen 이 참 좋습니다.

http://bbs.kldp.org/viewtopic.php?t=49745&highlight=doxygen

삽질의 대마왕...

익명 사용자의 이미지

글쓴이: 익명 사용자 / 작성시간: 월, 2005/05/23 - 1:07오후

doxygen도 생각안해본건 아니지만.

저번에 함 해봤던 경험으로는 약간 복잡 했던것 같기도 하고 생각만큼 간편하지 않더라구요.

휴휴...어찌 해야 할지...직접 만들어서 써야 될지 어떨지..고심중...

oldbell의 이미지

글쓴이: oldbell / 작성시간: 월, 2005/05/23 - 1:13오후

다들 C#, C++ 작업하시나보네요..

VB.NET에서는 잘 안되던데....

ㅠ.ㅠ

인생의 무게를 느껴라. 아는 만큼 보이는게다.

ssehoony의 이미지

글쓴이: ssehoony / 작성시간: 월, 2005/05/23 - 2:12오후

doxygen 과 docbook 은 성격이 좀 달라서 둘 중에 어떤걸 쓸까 비교 할게 못되는거 아닌가요?
doxygen 은 reference 용이고 docbook은 manual 혹은 guide book 정도 되는거 아닌가요?
물론 docbook 을 이용해 reference 를 만들겠다면 모르겠지만요. :D

creativeidler의 이미지

글쓴이: creativeidler / 작성시간: 월, 2005/05/23 - 3:04오후

xdoclet도 괜찮습니다.

익명 사용자의 이미지

글쓴이: 익명 사용자 / 작성시간: 월, 2005/05/23 - 4:08오후

ssehoony wrote:
doxygen 과 docbook 은 성격이 좀 달라서 둘 중에 어떤걸 쓸까 비교 할게 못되는거 아닌가요?
doxygen 은 reference 용이고 docbook은 manual 혹은 guide book 정도 되는거 아닌가요?
물론 docbook 을 이용해 reference 를 만들겠다면 모르겠지만요. :D

구분해서 생각하시나 보네요..저는 그게 그거로 보는데 --;;

익명 사용자의 이미지

글쓴이: 익명 사용자 / 작성시간: 월, 2005/05/23 - 4:12오후

creativeidler wrote:
xdoclet도 괜찮습니다.

가보니

XDoclet is an open source code generation engine. It enables Attribute-Oriented Programming for java

XDoclet은 오픈소스 코드제너레이션엔진이다.자바에서 속성지향 프로그래밍을 가능하게 해준다.

라고 나와있는데 이게 docbook이나 doxygen과 같은 documentation의 수단이라고 볼수 있는건지요?

ssehoony의 이미지

글쓴이: ssehoony / 작성시간: 월, 2005/05/23 - 4:27오후

Anonymous wrote:

구분해서 생각하시나 보네요..저는 그게 그거로 보는데 --;;

docbook 은 범용 문서를 만들기 위한 것이지 프로그램 코드 설명만을 위한것이 아니라서, 함수나 클래스 레퍼런스를 만들기 위해서 많은 수고가 필요합니다.(doxygen 에서는 소스를 분석해서 자동으로 해주는데 말이죠)

반대로 doxygen 은 개발자를 위한 레퍼런스 문서가 아닌 end-user 를 위한 사용자 메뉴얼을 만들기에는 문서형식이 적당하지 않고, 많은 양의 불필요한 자료가 생성됩니다.("man ls" 를 했는데 ls를 개발할때 이용하는 함수레퍼런스 정보가 튀어 나오면 당황스럽겠죠?)

그래서 저는 위의 두개를 각각의 목적에 맞게 둘을 구분해서 이용했었습니다.

지금은 docbook 은 사용하지 않습니다. docbook 은 일반 사용자나 직장 상사에게 건내기에는 너무 딱딱한 문서를 생성하는 듯 해서 요즘은 일반 워드프로세서를 이용해서 작성을 하고 있습니다. (워드프로세서도 맘에 들지는 않습니다. docbook과 워드프로세서 중간쯤 하는게 있으면 좋겠습니다. :) )

익명 사용자의 이미지

글쓴이: 익명 사용자 / 작성시간: 월, 2005/05/23 - 4:36오후

ㅎㅎㅎ

creativeidler의 이미지

글쓴이: creativeidler / 작성시간: 월, 2005/05/23 - 6:01오후

xdoclet은 doxygen과는 비슷한 기능을 수행할 수 있습니다. 굳이 자바 코드가 아니라도 약간의 변형으로 적용 가능하죠. xdoclet 변종(?)도 몇 가지 있구요. 근데 docbook은 문서 포맷이지 문서화 도구가 아닙니다.

creativeidler의 이미지

글쓴이: creativeidler / 작성시간: 월, 2005/05/23 - 6:09오후

어쨋든 문서화에서 요즘 추세는 별도로 문서를 만드는 방식이 아니라 코드에 문서의 내용을 기술하고 다른 도구를 통해 이를 HTML 등으로 변환하는 것인 듯 합니다. javadoc, pydoc 등이 이런 방식을 채택하고 있고 doxygen도 이런 도구죠. 그 외에 코드 분석 및 변환용 툴들이 여러 가지가 있습니다. 자신의 언어에 맞는 도구를 찾아 쓰시면 될 것입니다.

댓글 달기

텍스트 포맷에 대한 자세한 정보

Filtered HTML

  • 텍스트에 BBCode 태그를 사용할 수 있습니다. URL은 자동으로 링크 됩니다.
  • 사용할 수 있는 HTML 태그: <p><div><span><br><a><em><strong><del><ins><b><i><u><s><pre><code><cite><blockquote><ul><ol><li><dl><dt><dd><table><tr><td><th><thead><tbody><h1><h2><h3><h4><h5><h6><img><embed><object><param><hr>
  • 다음 태그를 이용하여 소스 코드 구문 강조를 할 수 있습니다: <code>, <blockcode>, <apache>, <applescript>, <autoconf>, <awk>, <bash>, <c>, <cpp>, <css>, <diff>, <drupal5>, <drupal6>, <gdb>, <html>, <html5>, <java>, <javascript>, <ldif>, <lua>, <make>, <mysql>, <perl>, <perl6>, <php>, <pgsql>, <proftpd>, <python>, <reg>, <spec>, <ruby>. 지원하는 태그 형식: <foo>, [foo].
  • web 주소와/이메일 주소를 클릭할 수 있는 링크로 자동으로 바꿉니다.

BBCode

  • 텍스트에 BBCode 태그를 사용할 수 있습니다. URL은 자동으로 링크 됩니다.
  • 다음 태그를 이용하여 소스 코드 구문 강조를 할 수 있습니다: <code>, <blockcode>, <apache>, <applescript>, <autoconf>, <awk>, <bash>, <c>, <cpp>, <css>, <diff>, <drupal5>, <drupal6>, <gdb>, <html>, <html5>, <java>, <javascript>, <ldif>, <lua>, <make>, <mysql>, <perl>, <perl6>, <php>, <pgsql>, <proftpd>, <python>, <reg>, <spec>, <ruby>. 지원하는 태그 형식: <foo>, [foo].
  • 사용할 수 있는 HTML 태그: <p><div><span><br><a><em><strong><del><ins><b><i><u><s><pre><code><cite><blockquote><ul><ol><li><dl><dt><dd><table><tr><td><th><thead><tbody><h1><h2><h3><h4><h5><h6><img><embed><object><param>
  • web 주소와/이메일 주소를 클릭할 수 있는 링크로 자동으로 바꿉니다.

Textile

  • 다음 태그를 이용하여 소스 코드 구문 강조를 할 수 있습니다: <code>, <blockcode>, <apache>, <applescript>, <autoconf>, <awk>, <bash>, <c>, <cpp>, <css>, <diff>, <drupal5>, <drupal6>, <gdb>, <html>, <html5>, <java>, <javascript>, <ldif>, <lua>, <make>, <mysql>, <perl>, <perl6>, <php>, <pgsql>, <proftpd>, <python>, <reg>, <spec>, <ruby>. 지원하는 태그 형식: <foo>, [foo].
  • You can use Textile markup to format text.
  • 사용할 수 있는 HTML 태그: <p><div><span><br><a><em><strong><del><ins><b><i><u><s><pre><code><cite><blockquote><ul><ol><li><dl><dt><dd><table><tr><td><th><thead><tbody><h1><h2><h3><h4><h5><h6><img><embed><object><param><hr>

Markdown

  • 다음 태그를 이용하여 소스 코드 구문 강조를 할 수 있습니다: <code>, <blockcode>, <apache>, <applescript>, <autoconf>, <awk>, <bash>, <c>, <cpp>, <css>, <diff>, <drupal5>, <drupal6>, <gdb>, <html>, <html5>, <java>, <javascript>, <ldif>, <lua>, <make>, <mysql>, <perl>, <perl6>, <php>, <pgsql>, <proftpd>, <python>, <reg>, <spec>, <ruby>. 지원하는 태그 형식: <foo>, [foo].
  • Quick Tips:
    • Two or more spaces at a line's end = Line break
    • Double returns = Paragraph
    • *Single asterisks* or _single underscores_ = Emphasis
    • **Double** or __double__ = Strong
    • This is [a link](http://the.link.example.com "The optional title text")
    For complete details on the Markdown syntax, see the Markdown documentation and Markdown Extra documentation for tables, footnotes, and more.
  • web 주소와/이메일 주소를 클릭할 수 있는 링크로 자동으로 바꿉니다.
  • 사용할 수 있는 HTML 태그: <p><div><span><br><a><em><strong><del><ins><b><i><u><s><pre><code><cite><blockquote><ul><ol><li><dl><dt><dd><table><tr><td><th><thead><tbody><h1><h2><h3><h4><h5><h6><img><embed><object><param><hr>

Plain text

  • HTML 태그를 사용할 수 없습니다.
  • web 주소와/이메일 주소를 클릭할 수 있는 링크로 자동으로 바꿉니다.
  • 줄과 단락은 자동으로 분리됩니다.
댓글 첨부 파일
이 댓글에 이미지나 파일을 업로드 합니다.
파일 크기는 8 MB보다 작아야 합니다.
허용할 파일 형식: txt pdf doc xls gif jpg jpeg mp3 png rar zip.
CAPTCHA
이것은 자동으로 스팸을 올리는 것을 막기 위해서 제공됩니다.