주석 (Summary)에서 see, seealso간 차이점 (From GPT)
1. <see>
태그
- 코드 내 특정 클래스, 메서드, 속성 등을 인라인(inline) 형식으로 참조합니다.
- 문서 내에서 하이퍼링크가 생성되며, 사용자가 해당 링크를 클릭하면 참조된 항목으로 이동할 수 있습니다.
사용 예제
/// <summary>
/// 이 메서드는 두 값을 더합니다. <see cref="Multiply(int, int)"/> 메서드를 참고하세요.
/// </summary>
public int Add(int a, int b)
{
return a + b;
}
/// <summary>
/// 두 값을 곱합니다.
/// </summary>
public int Multiply(int a, int b)
{
return a * b;
}
- 위 예제에서
<see cref="Multiply(int, int)"/>
은 Multiply
메서드로의 참조를 생성합니다.
- 문서를 확인할 때
Multiply(int, int)
가 하이퍼링크로 표시됩니다.
2. <seealso>
태그
- 참고할 만한 다른 항목을 별도로 강조해서 제공할 때 사용됩니다.
- 주로 "참고 문서(See Also)" 섹션을 만드는 데 사용됩니다.
사용 예제
/// <summary>
/// 이 메서드는 두 값을 더합니다.
/// </summary>
/// <seealso cref="Multiply(int, int)"/>
public int Add(int a, int b)
{
return a + b;
}
/// <summary>
/// 두 값을 곱합니다.
/// </summary>
public int Multiply(int a, int b)
{
return a * b;
}
<seealso cref="Multiply(int, int)"/>
는 문서의 "See Also" (참고) 섹션에 Multiply
메서드를 추가합니다.
<see>
와 달리 본문에 직접 나타나지 않고, "참고 항목"으로 별도 정리됩니다.
차이점 정리
태그 |
역할 |
표시 위치 |
<see> |
인라인에서 특정 항목을 참조 |
본문 내에서 하이퍼링크로 표시 |
<seealso> |
참고할 항목을 별도로 제공 |
"See Also" (참고) 섹션에 표시 |
언제 사용해야 할까?
- 코드 설명 중 자연스럽게 참조해야 할 때는
<see>
를 사용하세요.
- 별도의 참고 문서나 관련 정보를 강조하려면
<seealso>
를 사용하세요.
plugin, module 용어 (그냥) 간단 구분
- Module : 해당 프로젝트 내부의 서브 프로젝트. 또는 dll 처럼 생각
- Plugin : 외부 프로젝트
- 해당 플러그인이 어떤 module (서브 프로젝트)로 구성되어 있는지는 모름
댓글
댓글 쓰기