문서작성을 위한 .txt 파일의 마킹 업(Marking up)
문서작성을 위해서는 사용자의 .txt 파일이 올바르게 마크 업 하는 것은, 우리가 이 정보를 웹 사이트에 스크립트 문서로 출판하여 누구나 볼 수 있게 하기 때문에 매우 중요합니다.
문서 작성을 위해 다음 항목들이 지원됩니다:
문서화 하지 않으려면 / *undocumented*을 class/function/property 태그 앞에 붙입니다.
/ 은 class/function/property 문서화를 위한 것 입니다. 이것은 선언 앞에 두어야 합니다.
doc 문자열 내에서는, 여러 종류의 하이퍼링크를 지원합니다:
[=[[ClassName]]=] --> < a href="ClassName.html">ClassName</a> (실제로는 '<' 'a href'사이의 스페이스 제거해야 함) ::ref::propName --> < a href="CurrentClass-propName.html">propName</a> ::ref::MethodName --> < a href="CurrentClass.MethodName.html">MethodName</a> ClassName::ref::propName --> < a href="ClassName-propName.html">ClassName.propName</a> ClassName::ref::MethodName --> < a href="ClassName.MethodName.html">ClassName.MethodName</a> ClassName::pref::propName --> < a href="ClassName-propName.html">propName</a> ClassName::pref::MethodName --> < a href="ClassName.MethodName.html">MethodName</a> ClassName's PropName property --> < a href="ClassName-propName.html">ClassName's propName property</a> ClassName's PropName !property --> < a href="ClassName-propName.html">ClassName's propName</a> ClassName's MethodName method --> < a href="ClassName.MethodName.html">ClassName's MethodName method</a> ClassName's MethodName !method --> < a href="ClassName.MethodName.html">ClassName's MethodName</a> [wiki:manual_page|Link Text]] --> < a href="../Manual|Component/manual_page.html">Link Text</a>
또한:
[=_x_=] x 을 굵은체로 [=//x//=] x 을 이탤릭체로 [=''x''=] x을 monospace로 [=/x/=] x 을 이탤릭으로 (x 는 빈 공간으로 둘러싸여야 함has to be surrounded by whitespace) [==] line break 입력 (\\).
SA: 'See Also' 라인을 특정 스타일로 만듬line in a specific style.
(RO) (Read Only)로 확장 {img foo.png} --> %apply=img class='refimg' %ScriptRefImages/foo.png%%
다른 규칙들:
속성을 문서화 할 때, _ 첫 줄은 완전한 개요 문장이 _ 되게 합니다. 첫 라인은 class overview pages에서 사용됩니다.
여러 라인의 doc과 그 예제:
여러 라인의 docs 문장을 아래와 같이 포함할 수 있습니다:
BEGIN DOC
...
END DOC
코드 예제는 다음과 같이 마크 됩니다.
BEGIN EX
...
END EX
BEGIN EX 바로 앞에 CONVERTEXAMPLE을 사용하면, 해당 doc에 대한 C# 예제와 Boo 예제를 주입하기 위해 예제 변환 파서(example converter parser)가 구동합니다.
CONVERTEXAMPLE
BEGIN EX
Debug.Log("this is an example"); \\
END EX
Happy formatting!
- 출처: 유니티코리아위키 (CC BY-NC-SA 2.0)