이 repo에는 .NET 문서에 따라 모든 주제의 일부인 모든 샘플 코드가 포함되어 있습니다. 하위 폴더로 구성된 여러 프로젝트가 있습니다. 이 하위 폴더는 .NET 용 문서의 구성과 유사하게 구성됩니다. 기사 중 일부에는 둘 이상의 샘플이 관련되어 있습니다.
컨텐츠 팀은 DotNet/Docs 및 DOTNET/DOTNET-API-DOCS 리포지토리의 .NET 문서 문제를 추적합니다. 이 저장소에서 문제가 꺼져 있습니다. 기존 샘플에 대한 파일 문제 및 해당 리포지토리의 새로운 샘플에 대한 제안. 어디에 있는지 확실하지 않으면 Dotnet/Docs를 선택하십시오. 이 프로세스는 각 샘플의 개념을 설명하는 기사와 관련된 문제를 유지합니다. 가장 좋은 과정은 각 문서 페이지의 하단에있는 피드백 컨트롤에서 문제를 제출하는 것입니다.
이 저장소의 코드는 응용 프로그램 또는 라이브러리 시나리오를 보여주는 프로그램을 나타냅니다. 이 샘플은 종종 하나 이상의 기술, 기능 또는 툴킷을 사용합니다. 각 샘플에는 샘플을 설명하는 readme.md 파일이 있으며 자세한 내용은 리소스 링크를 설명합니다.
샘플은 구축 가능한 프로젝트 여야합니다. 이러한 프로젝트는 주어진 샘플에 대해 가능한 가장 광범위한 플랫폼 세트를 구축하고 실행해야합니다. 실제로, 이는 가능한 경우 .NET 코어 기반 콘솔 애플리케이션을 구축하는 것을 의미합니다. 웹 또는 UI 프레임 워크에 특정한 샘플은 필요에 따라 해당 도구를 추가해야합니다. 예로는 웹 응용 프로그램, 모바일 앱, WPF 또는 Windows Forms 앱 등이 있습니다.
우리는 모든 코드에 대한 CI 시스템을 갖추기 위해 노력하고 있습니다. 샘플을 업데이트 할 때 각 업데이트가 빌드 가능한 프로젝트의 일부인지 확인하십시오. 이상적으로는 샘플에 대한 정확성에 대한 테스트를 추가하십시오.
.NET Core SDK와 함께 설치된 .NET Core CLI를 사용하여 .NET 코어 샘플을 빌드하십시오. 그런 다음 샘플의 디렉토리에서 CLI 에서이 명령을 실행하십시오.
dotnet build
dotnet run이들은 필요한 종속성을 설치하고 프로젝트를 구축하며 프로젝트를 각각 운영합니다.
다중 프로 샘플 샘플은 root 디렉토리에 README.md 파일의 지침이 있습니다.
언급 한 경우를 제외하고 모든 샘플은 .NET Core가 지원하는 모든 플랫폼의 명령 줄에서 빌드됩니다. Visual Studio와 관련하여 Visual Studio 2017 이상이 필요한 몇 가지 샘플이 있습니다. 또한 일부 샘플에는 플랫폼 별 기능이 표시되며 특정 플랫폼이 필요합니다. 다른 샘플과 스 니펫에는 .NET 프레임 워크가 필요하며 Windows 플랫폼에서 실행되며 대상 프레임 워크 버전의 개발자 팩이 필요합니다.
코드 샘플을 추가하려면 :
샘플은 빌드 가능한 프로젝트의 일부 여야합니다 . 가능한 경우 프로젝트는 .NET Core가 지원하는 모든 플랫폼을 구축해야합니다. 이에 대한 예외는 플랫폼 별 기능 또는 플랫폼 별 도구를 보여주는 샘플입니다.
샘플은 일관성을 유지하기 위해 런타임 코딩 스타일을 준수해야합니다.
static 방법을 사용하는 것을 선호합니다.샘플에는 적절한 예외 처리가 포함되어야합니다. 샘플의 맥락에서 던질 수있는 모든 예외를 처리해야합니다. 예를 들어, Console.Readline 메소드를 호출하는 샘플 사용자 입력을 검색하려면 입력 문자열이 메소드에 인수로 전달 될 때 적절한 예외 처리를 사용해야합니다. 마찬가지로 샘플에서 메소드 호출이 실패 할 것으로 예상되면 결과 예외를 처리해야합니다. 예외 또는 SystemException과 같은 기본 클래스 예외가 아니라 메소드에 의해 발생 된 특정 예외를 항상 처리하십시오.
샘플이 독립형 패키지를 빌드하는 경우 CI 빌드 시스템에서 사용하는 런타임이 샘플에서 사용하는 런타임 외에도 다음을 포함해야합니다.
win7-x64win8-x64win81-x64ubuntu.16.04-x64우리는 이러한 프로젝트를 곧 구축하기 위해 CI 시스템을 갖추게 될 것입니다.
샘플을 만들려면 :
문제를 제기하거나 작업중인 기존 기존에 주석을 추가하십시오.
샘플에서 시연 된 개념을 설명하는 주제를 작성하십시오 (예 : docs/standard/linq/where-clause.md ).
샘플을 작성하십시오 (예 : whereclause-sample1.cs ).
샘플을 호출하는 메인 진입 점이있는 program.cs를 만듭니다. 이미 하나가 있다면 샘플에 통화를 추가하십시오.
public class Program
{
public void Main ( string [ ] args )
{
WhereClause1 . QuerySyntaxExample ( ) ;
// Add the method syntax as an example.
WhereClause1 . MethodSyntaxExample ( ) ;
}
}하나의 프로젝트 만 포함 된 경우 솔루션 파일을 확인하지 마십시오.
샘플을 구축하고 실행하려면 :
샘플 폴더로 이동하여 오류를 확인하려면 빌드하십시오.
dotnet build샘플 실행 :
dotnet run샘플의 루트 디렉토리에 readme.md를 추가하십시오.
여기에는 코드에 대한 간단한 설명이 포함되어야하며 사람들에게 샘플을 참조하는 기사를 참조하십시오.