사용법이라고 특별한게 없습니다. 소스코드의 주석을 일정한 포맷으로 작성하고 pasdoc을 이용해서 실행하면 알아서 HTML 또는 HTML HELP(CHM)가 나오죠... LATEX까지 나오고...
간단한 예를 들어보겠습니다...
Unit의 코멘트 포맷은 이렇습니다.
<!--CodeS-->
{
@abstract(provides access to file and directory operations)
@author(John Doe <doe@john-doe.com>)
@created(July 12, 1997)
@lastmod(June 20, 1999)
The DOS unit provides functionality to get information on files and
directories and to modify some of this information.
This includes disk space (e.g. @link(DiskFree)), access rights, file
and directory lists, changing the current directory, deleting files
and directories and creating directories.
Some of the functions are not available on all operating systems.
}
unit DOS;
....
<!--CodeE-->
저렇게 넣으시면.. 유닛 설명에 해당내용이 들어가게 됩니다... @abstract(내용) 처럼 콜뱅이 + 키워드 + ( 내용 ) 이런 형식이죠..
@link() 를 사용해서 특정 키워드로 HTML링크도 걸 수 있습니다.. 현재 0.8.8까지 나와있는데.. 설명 부분에 한글을 그냥 사용하시면.. HTML 헬프 생성시 한글이 깨지는 문제가 있습니다만.. @html( 한글 ) 태그로 사용하시면 한글도 적을 수 있습니다..
@html() 태그 사용하지 않고 한글 사용하려면.. 인코딩하는 부분에 약간(아주 약간-_-;;) 패치를 해야하는데.. 제 홈피 가보면.. 코드 올라와 있습니다. 참고하시구요... 그냥 @html() 코드 사용해도 무방할것 같습니다.
그럼 이렇게 코드내에 코멘트를 달아주시고... pasdoc 실행파일로 빌드하면 됩니다.. 이름이 생각나지 않는데... GUI로 빌드해주도록 툴도 있습니다... -_-;;;; 음.. 암턴..
저는 걍 batch 파일로 간단히 만들어 특정 모듈 또는 프로젝트 단위로 생성합니다...
batch 파일 내용은 이렇습니다.
[시작]
if not exist .\Source\MyClass\nul mkdir .\Source\MyClass
del .\Source\MyClass\*.chm
del .\Source\MyClass\*.hhc
del .\Source\MyClass\*.hhk
del .\Source\MyClass\*.hhp
del .\Source\MyClass\*.htm*
del .\Source\MyClass\*.gif
del .\Source\MyClass\*.log
-T 옵션은 Help의 제목입니다.
-O 옵션은 Help 대상을 지정하는것으로
latex: Latex 생성
latex2rtf: Latex 생성한 내용을 워드에서 사용할 수 있도록 변환해 줍니다.
html: HTML 만 생성(도움말)
htmlhelp: HTML 을 CHM 까지 생성(HTML Help Workshop이 설치되어 있어야합니다.)
-L 옵션은 언어 설정입니다.. 단순한 키워드같은 걸들만 변경됩니다.
-E 옵션은 Help 생성 경로입니다.
마지막 옵션은 소스 경로 입니다.
대충 이렇습니다... 자세한 키워드와 사용법은 역시나 문서를 보셔야 깔끔하게 정리될 듯 싶습니다만.. ^^;;;
도움이 되셨길 바랍니다.
사용법이라고 특별한게 없습니다. 소스코드의 주석을 일정한 포맷으로 작성하고 pasdoc을 이용해서 실행하면 알아서 HTML 또는 HTML HELP(CHM)가 나오죠... LATEX까지 나오고...
간단한 예를 들어보겠습니다...
Unit의 코멘트 포맷은 이렇습니다.
<!--CodeS-->
{
@abstract(provides access to file and directory operations)
@author(John Doe <doe@john-doe.com>)
@created(July 12, 1997)
@lastmod(June 20, 1999)
The DOS unit provides functionality to get information on files and
directories and to modify some of this information.
This includes disk space (e.g. @link(DiskFree)), access rights, file
and directory lists, changing the current directory, deleting files
and directories and creating directories.
Some of the functions are not available on all operating systems.
}
unit DOS;
....
<!--CodeE-->
저렇게 넣으시면.. 유닛 설명에 해당내용이 들어가게 됩니다... @abstract(내용) 처럼 콜뱅이 + 키워드 + ( 내용 ) 이런 형식이죠..
@link() 를 사용해서 특정 키워드로 HTML링크도 걸 수 있습니다.. 현재 0.8.8까지 나와있는데.. 설명 부분에 한글을 그냥 사용하시면.. HTML 헬프 생성시 한글이 깨지는 문제가 있습니다만.. @html( 한글 ) 태그로 사용하시면 한글도 적을 수 있습니다..
@html() 태그 사용하지 않고 한글 사용하려면.. 인코딩하는 부분에 약간(아주 약간-_-;;) 패치를 해야하는데.. 제 홈피 가보면.. 코드 올라와 있습니다. 참고하시구요... 그냥 @html() 코드 사용해도 무방할것 같습니다.
그럼 이렇게 코드내에 코멘트를 달아주시고... pasdoc 실행파일로 빌드하면 됩니다.. 이름이 생각나지 않는데... GUI로 빌드해주도록 툴도 있습니다... -_-;;;; 음.. 암턴..
저는 걍 batch 파일로 간단히 만들어 특정 모듈 또는 프로젝트 단위로 생성합니다...
batch 파일 내용은 이렇습니다.
[시작]
if not exist .\Source\MyClass\nul mkdir .\Source\MyClass
del .\Source\MyClass\*.chm
del .\Source\MyClass\*.hhc
del .\Source\MyClass\*.hhk
del .\Source\MyClass\*.hhp
del .\Source\MyClass\*.htm*
del .\Source\MyClass\*.gif
del .\Source\MyClass\*.log
pasdoc.exe -T"타이틀입니다...." -OHtmlhelp -E.\Source\MyClass ..\..\Dev\Common\*.pas
[끝]
-T 옵션은 Help의 제목입니다.
-O 옵션은 Help 대상을 지정하는것으로
latex: Latex 생성
latex2rtf: Latex 생성한 내용을 워드에서 사용할 수 있도록 변환해 줍니다.
html: HTML 만 생성(도움말)
htmlhelp: HTML 을 CHM 까지 생성(HTML Help Workshop이 설치되어 있어야합니다.)
-L 옵션은 언어 설정입니다.. 단순한 키워드같은 걸들만 변경됩니다.
-E 옵션은 Help 생성 경로입니다.
마지막 옵션은 소스 경로 입니다.
대충 이렇습니다... 자세한 키워드와 사용법은 역시나 문서를 보셔야 깔끔하게 정리될 듯 싶습니다만.. ^^;;;
도움이 되셨길 바랍니다.
제홈페이지에 약간 설명해 놓은게 있는데 참고하시구요..
http://bastad.pe.kr/pmwiki/pmwiki.php/Interested/PascalDocumentation