메뉴 건너뛰기

창작에 관련된 질문이나 간단한 팁, 예제를 올리는 곳

다운로드

https://github.com/lunarmodules/LDoc

 

penlight 설치가 필요

luarocks install penlight

 

프로젝트가 있는 폴더에서 아래의 명령행을 실행

lua /path/to/ldoc/ldoc.lua $*

 

https://stevedonovan.github.io/ldoc/manual/doc.md.html

 

문서 코멘트라는걸 작성하면 나중에 문서로 취합해줌

모든 문서 코멘트는 세 개의 하이픈(---)으로 시작

--- 예시 문서 코멘트

-- @tag 태그1

-- @tag 태그2

 

자주 사용하는 태그의 종류로는

@module - 모듈

@script - 루아 프로그램

@author, copyright, license, release - 프로젝트 레벨 태그들에 쓰이는 태그 (예: @module)

@function - 함수

@param - 파라미터 (여러개 가능)

@return - 함수의 리턴값 (여러개 가능)

@usage - 예제 사용법

@table - 루아 테이블

@fixme, todo, warning - 안내를 위한 주석

 

모듈에 적용

--- a test module

-- @module test

local test = {}

function test.my_module_function_1()

    ...

end

...

return test

 

함수에 적용

--- foo explodes text.

-- It is a specialized splitting operation on a string.

-- @param text the string

-- @return a table of substrings

function foo (text)

....

end

 

파라미터와 리턴값

-- @param name_of_parameter the description of this parameter as verbose text

-- @return the description of the return value

 

타입을 지정하고 싶을 경우 tparam, treturn 태그를 사용하면 됨

-- @tparam string text this parameter is named 'text' and has the fixed type 'string'

-- @treturn {string,...} a table of substrings

 
param과 return 태그는 여러개 쓸 수 있다.
--- solve a quadratic equation.
-- @param a first coeff
-- @param b second coeff
-- @param c third coeff
-- @return first root, or nil
-- @return second root, or imaginary root error
function solve (a,b,c)
    local disc = b^2 - 4*a*c
    if disc < 0 then
        return nil,"imaginary roots"
    else
       disc = math.sqrt(disc)
       return (-b + disc)/2*a,
              (-b - disc)/2*a
    end
end
 
...
 
todo, fixme 태그
--- Testing annotations
-- @module annot1
...
--- first function.
-- @todo check if this works!
function annot1.first ()
    if boo then
 
    end
    --- @fixme what about else?
end
 
todo, fixme 태그를 추출하기 위해서는 --tags 옵션을 사용
D:\dev\lua\LDoc\tests> ldoc --tags todo,fixme annot1.lua
d:\dev\lua\ldoc\tests\annot1.lua:14: first: todo check if this works!
d:\dev\lua\ldoc\tests\annot1.lua:19: first-fixme1: fixme what about else?
 
 
분류 :
조회 수 :
4
등록일 :
2021.01.11
11:53:51 (*.47.15.90)
엮인글 :
게시글 주소 :
https://hondoom.com/zbxe/index.php?mid=study&document_srl=819158
List of Articles
번호 제목 글쓴이 날짜 조회 수sort
180 VC++ 2008 Express Edition에서 문D라이브 링크 [2] A.미스릴 2008-04-17 13080
179 cocos2d-x 터치와 업데이트 활성화 시키기 똥똥배 2011-10-27 10647
178 문D 질문 #2 [1] A.미스릴 2008-06-01 8795
177 MFC 더블 버퍼링 질문 [2] A.미스릴 2008-06-13 6542
176 문D라이브로 만드는 더블드래곤.. 질문입니다 [4] 하와이안 2009-01-15 5545
175 임의의 점이 다각형 내부에 있는지 검사하는 함수 똥똥배 2008-04-14 5338
174 문D라이브로 더블드래곤을 만들자(11) file 똥똥배 2008-05-17 4647
173 문D라이브로 더블드래곤을 만들자(1) [2] file 똥똥배 2008-04-16 4478
172 씨언어 질문 (내일 시험 ㄷㄷ) [1] 쿠로쇼우 2008-06-17 4326
171 문D라이브도 더블버퍼링이 필요한가요? [3] A.미스릴 2008-06-28 4219
170 문D라이브로 더블드래곤을 만들자(10) file 똥똥배 2008-05-17 4063
169 #define에 대해 [1] A.미스릴 2008-05-19 4060
168 클레스들을 담은 헤더들의 혼란 [4] A.미스릴 2008-06-21 3890
167 srand에 관해서 [4] A.미스릴 2008-07-15 3859
166 문D 질문 [5] A.미스릴 2008-05-26 3844
165 흥크립트에 궁금한점 [4] 상상악수 2008-08-21 3834
164 C++ 질문 [1] A.미스릴 2008-12-21 3814
163 문D라이브 2008년 5월 19일 버전 [2] 혼돈 2008-06-02 3746
162 COgg 질문 [3] A.미스릴 2008-06-29 3709
161 문D라이브로 더블드래곤을 만들자(2) [6] file 똥똥배 2008-04-18 3609