문서 예제

문서는 좋은 패키지의 가장 중요한 측면 중 하나입니다. 그것 없이, 사용자는 패키지를 사용 하는 방법을 알 수 없습니다. 설명서는 미래의 기능(함수가 수행해야 하는 작업을 기억함)과 패키지를 확장하는 개발자에게도 유용합니다. 함수는 가장 일반적으로 문서화된 개체입니다. 소개 블록뿐만 아니라 대부분의 함수에는 @param, @examples 및 @return 세 가지 태그가 있습니다. % 이는 일반적으로 줄의 끝까지 계속 라텍스 주석의 시작을 표시합니다. %를 사용하여 출력 문서에 리터럴 %를 삽입합니다. 예제에서는 이스케이프가 필요하지 않습니다. @examples 실제로 함수를 사용하는 방법을 보여 제공하는 실행 가능한 R 코드를 제공합니다. 이것은 많은 사람들이 예제를 먼저 살펴보기 때문에 설명서에서 매우 중요한 부분입니다.

예제 코드는 R CMD 검사의 일부로 자동으로 실행되기 때문에 오류 없이 작동해야 합니다. setClass() 전에 roxygen 블록을 추가하여 S4 클래스를 문서화합니다. @slot 사용하여 함수의 매개 변수를 설명하는 @param 사용하는 것과 동일한 방식으로 클래스의 슬롯을 문서화합니다. 간단한 예: 설명서에 직접 예제를 포함하는 대신 별도의 파일에 배치하고 @example 경로/상대/에/패키지/루트를 사용하여 설명서에 삽입할 수 있습니다. (여기에 @example 태그에는 `s`가 없습니다. 프린스는 HTML 페이지에서 PDF 송장을 생성하는 데 자주 사용됩니다. 고객은 먼저 화면에서 송장을 보고 레코드에 대한 인쇄 가능한 PDF 버전을 받습니다. 여기에서 송장의 두 가지 예, 하나의 다채로운, 다른 더 보수적 인 것을 찾을 수 있습니다. 문서는 비밀, 비공개 또는 공개로 분류되는 경우도 있습니다. 그들은 또한 초안 또는 증거로 설명 될 수있다.

문서를 복사하면 원본이 “원본”으로 표시됩니다. 문서는 생각의 서면, 그린, 제시, 또는 기념 표현이다. 문서는 생각의 라인을 훈련 하는 양식, 또는 기록 된 조각 또는 역사에서, 중요 한 이벤트. 이 단어는 “가르침” 또는 “교훈”을 의미하는 라틴어 다큐멘터리에서 유래되었습니다. 과거에는 일반적으로 진실이나 사실의 증거로 유용한 서면 증거를 나타내는 데 사용되었습니다. 컴퓨터 시대에 “문서”는 일반적으로 글꼴, 색상 및 이미지와 같은 구조와 형식을 포함하여 주로 텍스트 컴퓨터 파일을 나타냅니다. 전자 문서의 존재를 감안할 때, “문서”는 전송 매체, 예를 들어, 종이에 의해 정의되지 않습니다. “문서”는 “문서”보다 더 많은 주석을 가지고 있기 때문에 구별됩니다. 문서는 또한 “realia”와 구별되며, 이는 생각을 기념하거나 나타내기 때문에 “문서”의 정의를 충족시키는 3차원 객체입니다. 문서는 2차원 표현으로 간주됩니다.

문서는 다양한 종류의 사용자 정의를 가질 수 있지만 모든 문서는 자유롭게 공유 할 수 있으며 그렇게 할 수있는 권리가 있으며 창의성은 문서로 표현 될 수 있습니다. 역사, 사건, 예, 의견 등은 모두 문서로 표현할 수 있습니다. “문서”는 도서관과 정보 과학 및 문서 과학에서 근본적이고 추상적인 아이디어로 정의됩니다: 단어는 증거로 쓰이기 위해 표현되거나 기념될 수 있는 모든 것을 나타냅니다. 수잔 브리엣이 제공하는 고전적인 예는 영양입니다: “아프리카의 평원에서 야생으로 달리는 영양은 문서로 간주되어서는 안됩니다[;] 그녀는 규칙.

Comments are closed