csharp-docs은(는) 무엇을 하나요?
C# 타입에 XML 주석 문서를 추가하고 문서화 모범 사례를 따르도록 보장합니다.
설명
이 스킬은 C# 코드에서 모든 public 타입과 멤버가 올바른 XML 문서 주석을 포함하도록 강제합니다. 이를 통해 코드 가독성과 유지보수성을 향상시키고, 자동 생성된 문서의 품질을 보장합니다.
주요 기능
- 모든 public 타입, 메서드, 프로퍼티, 필드에 XML 주석을 확인하고 추가
- 누락된
<summary>,<param>,<returns>태그 자동 생성 - 불완전하거나 부정확한 문서 식별 및 수정 제안
- 표준 .NET 문서화 모범 사례 준수
사용 예시
/// <summary>
/// 사용자 인증을 처리합니다.
/// </summary>
public class AuthenticationService
{
/// <summary>
/// 지정된 자격 증명으로 사용자를 인증합니다.
/// </summary>
/// <param name="username">사용자 이름</param>
/// <param name="password">비밀번호</param>
/// <returns>인증 성공 시 true, 실패 시 false</returns>
public bool Authenticate(string username, string password)
{
// 구현
}
}
지원 플랫폼
- Claude Code
- Cursor
- Codex
- 기타 AI 코딩 에이전트