xml.md
기본
<summary>: 한 줄 설명
/// <summary>
/// 플레이어의 체력과 사망 처리를 관리한다.
/// </summary>
public class PlayerHealth : MonoBehaviour
<remarks>: 비고, 보충 설명
/// <summary>
/// 오브젝트 풀에서 총알을 꺼낸다.
/// </summary>
/// <remarks>
/// 풀이 비어 있으면 새로 생성하므로 첫 프레임에 할당이 발생할 수 있다.
/// </remarks>
public Bullet Get()
멤버
<returns>: 반환값
/// <summary>
/// 인벤토리에서 아이템의 위치를 찾는다.
/// </summary>
/// <returns>아이템이 있는 칸 번호. 없으면 -1.</returns>
public int FindSlot(int itemId)
<param name="">: 매개변수 설명
/// <summary>
/// 대상에게 피해를 준다.
/// </summary>
/// <param name="amount">피해량. 0 이하면 무시한다.</param>
/// <param name="attacker">공격한 오브젝트. 없으면 null.</param>
public void TakeDamage(int amount, GameObject attacker)
<paramref name="">: 본문의 매개변수 설명
/// <summary>
/// <paramref name="duration"/> 초 동안 무적 상태가 된다.
/// </summary>
/// <param name="duration">무적 시간(초)</param>
public void SetInvincible(float duration)
<exception cref="">: 던지는 예외
/// <summary>
/// 저장 파일을 불러온다.
/// </summary>
/// <exception cref="FileNotFoundException">저장 파일이 없을 때</exception>
public SaveData Load(string path)
<value>: 속성 값 설명
/// <summary>
/// 현재 체력
/// </summary>
/// <value>0 ~ <see cref="MaxHp"/> 사이의 값</value>
public int Hp { get; private set; }
서식
<para>: 문단 나누기
/// <remarks>
/// <para>매 프레임 호출되므로 할당을 하지 않는다.</para>
/// <para>일시정지 중에는 호출되지 않는다.</para>
/// </remarks>
<list type="">: 리스트
/// <summary>
/// 지원 기능:
/// <list type="bullet">
/// <item>
/// <description>이동</description>
/// </item>
/// <item>
/// <description>점프</description>
/// </item>
/// </list>
/// </summary>
<c>: 인라인 코드
/// <summary>
/// <c>Time.timeScale</c> 이 0 이어도 동작한다.
/// </summary>
<code>: 다중행 코드
/// <code>
/// var bullet = pool.Get();
/// bullet.Fire(direction);
/// pool.Release(bullet);
/// </code>
<example>: 사용 예시
/// <example>
/// <code>
/// health.TakeDamage(10, gameObject);
/// </code>
/// </example>
<b>, <i>, <u>, <br/>, <a href="">: 서식
/// <summary>
/// <b>메인 스레드에서만</b> 호출한다.<br/>
/// 자세한 내용은 <a href="https://docs.unity3d.com/Manual/index.html">유니티 매뉴얼</a> 참고.
/// </summary>
재사용
<inheritdoc/>: 부모의 주석 상속
/// <inheritdoc/>
public override void Interact(Player player)
<include file='' path=''/>: 다른 XML 파일의 주석
/// <include file='Docs/Inventory.xml' path='doc/members/member[@name="AddItem"]/*'/>
public bool AddItem(Item item)
링크
<see cref="">: 코드 요소 링크
/// <summary>
/// 체력이 0 이 되면 <see cref="OnDeath"/> 를 호출한다.
/// </summary>
<see href="">: 웹 링크
/// <summary>
/// 경로 탐색은 <see href="https://en.wikipedia.org/wiki/A*_search_algorithm">A*</see> 를 쓴다.
/// </summary>
<see langword=""/>: 언어 키워드
/// <returns>대상이 없으면 <see langword="null"/></returns>
public Enemy FindNearestEnemy()
<seealso cref="">: 참고 링크. <summary> 안에 삽입 불가능
/// <summary>
/// 게임을 저장한다.
/// </summary>
/// <seealso cref="Load"/>
public void Save()
제네릭
<typeparam name="">: 제네릭 타입 매개변수
/// <summary>
/// 컴포넌트 단위 오브젝트 풀
/// </summary>
/// <typeparam name="T">풀에 담을 컴포넌트 타입</typeparam>
public class ObjectPool<T> where T : Component
<typeparamref name="">: 본문의 제네릭 타입 매개변수
/// <summary>
/// 씬에서 <typeparamref name="T"/> 타입의 매니저를 찾는다.
/// </summary>
public static T GetManager<T>() where T : MonoBehaviour
기타
<!-- -->: XML의 주석
/// <summary>
/// 적을 생성한다.
/// <!-- TODO: 웨이브 정보 설명 추가 -->
/// </summary>
<![CDATA[ ]]>: 안의 <, >, & 기호를 그대로 출력
/// <remarks>
/// <![CDATA[ hp > 0 && hp <= maxHp ]]> 를 항상 만족한다.
/// </remarks>