예외적 인 C# 소스 코드 문서의 예

뛰어난 소스 레벨 문서가있는 C# 프로젝트의 예는 무엇입니까?예외적 인 C# 소스 코드 문서의 예

감사합니다.

2011-05-11 Nick Carlson

** [이 BitStream 클래스] (http://www.codeproject.com/KB/cs/bitstream.aspx)에는 전체 XML 도움말이 포함되어있어 전체 설명서 도움말 파일에서 소스에서 직접 생성 할 수 있습니다. 또한 클래스 작동 방식과 사용 방법을 명확하게 알 수있는 샘플 응용 프로그램도 포함되어 있습니다. –

Telerik은 대개 코드를 예외적으로 잘 문서화합니다. 자신의 MVC extensions project on Codeplex을 확인하십시오.

출처

2011-05-11 19:40:38

해당 프로젝트의 소스 파일의 상당 부분이 완전히 문서화되지 않았습니다. –

뛰어난 문서는 주관적인 것입니다.

명확하고 간결하고 읽기 쉬운 코드를 작성하는 데 초점을 맞추고 좋은 문서에 대해 걱정하는 것보다 코드의 비즈니스 목적을 문서화하는 것이 목적 (명확하지 않은 경우)보다 훨씬 중요하다고 생각합니다.

실제로 설명서는 코드 변경 사항을 거의 따라 가지 않습니다. (적어도 내 경험에서)

출처

2011-05-11 19:41:50 David

자체 문서화 코드는 약간의 신화입니다. 클래스는 자체 설명 할 수 있지만 클래스 간의 관계 (및 해당 클래스의 적절한 사용 시나리오)가 항상 명확하지는 않습니다. 이것은 문서화가 황금으로 가치있게되는 곳입니다. 이것이 사실이 아니라면 Microsoft는 단순히 .NET 프레임 워크를 릴리스하고 문서 또는 코드 샘플을 작성하지 않아도됩니다. –

설명서에 변경 사항이 반영되지 않으면 코드 변경이 이루어지지 않았 으면 좋겠습니다. –

@ 로버트 하비 - 동의해야 할 것 같습니다. 내가 주로 내부 코드 주석을 설명하는 질문으로 생각했다. API를 작성하는 회사는 C# 및 VB.NET의 XML 주석 기능 (기술적으로 코드 주석)을 사용하여 외부 문서를 만드는 경향이 있다는 것을 잊어 버렸습니다. 우리의 외부 문서의 대부분은 코드 주석 이외의 소스에서 왔기 때문에 그들은 다른 존재이며, 우리는 외부 문서를 최신으로 유지합니다. 우리의 개발 프로세스에는 문서 검토 및이를 보장하는 코드 검토가 포함됩니다. – David

예외적 인 C# 소스 코드 문서의 예

답변

관련 문제