C# 코드에 주석을 달기 위한 표준(phpdoc 또는 Python의 docstring과 같은)이 있습니까?

Question

클래스 문서가 소스 코드에서 자동으로 생성될 수 있도록 C# 코드에 주석을 달기 위한 표준 규칙(예: phpdoc 또는 Python의 docstring)이 있습니까?

Answer 1

XML 스타일 주석을 사용하고 도구를 사용하여 해당 주석을 API 문서로 가져올 수 있습니다.

다음은 주석 스타일의 예입니다.

/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True, if authentication is successful, otherwise False.
/// </returns>
/// <remarks>
/// For use with local systems
/// </remarks>
public override bool Authenticate(string username, string password)

이를 촉진하는 몇 가지 항목은 다음과 같습니다.

GhostDoc, 클래스나 메소드에 대한 주석을 자동으로 생성하는 단일 단축키를 제공합니다.모래성, XML 주석에서 MSDN 스타일 문서를 생성합니다.

Answer 2

/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 3

마이크로소프트는 "XML 문서 주석" IDE intellisense 설명을 제공하고 XML 파일 출력 생성을 켜면 Sandcastle과 같은 도구를 사용하여 MSDN 스타일 문서를 자동 생성할 수도 있습니다.

문서용 XML 파일 생성을 켜려면 Visual Studio에서 프로젝트를 마우스 오른쪽 버튼으로 클릭하고 "속성"을 클릭한 다음 "빌드" 탭으로 이동합니다.하단에서는 XML 주석 출력 파일의 위치를 ​​지정할 수 있습니다.

Answer 4

이전 답변은 XML 구문을 완벽하게 지적합니다.그냥 추천을 드리고 싶었어요 무료(및 오픈 소스) nDoc 도움말 라이브러리 생성기 프로젝트의 모든 주석을 구문 분석합니다.

Answer 5

C#이 내장되어 있습니다. 문서화 명령재미있게 보내세요!

Answer 6

나는 항상 2개 이상의 별표로 열린 블록 주석을 사용하여 문서 주석을 구분하라는 지시를 받았습니다.

/**
Documentation goes here.
(flowerboxes optional) 
*/