델파이 여러 줄 주석. Delphi의 XML 주석 및 문서 생성. Delphi를 사용하여 문서 생성

두 번째 방법은 Delphi의 많은 방법과 마찬가지로 완전히 명확하지 않습니다. IDE와 함께 제공되는 유틸리티를 사용합니다. XMLDoc. 폴더에서 확인 가능합니다 내 문서\RAD Studio\<версия Delphi>\Demos\XMLDoc. 또한 Java SDK(1.4.2 이상), Python(최소 2.3) 및 Java용 버전 6.5.5를 설치해야 합니다. 설치 후에는 다음이 필요합니다. 추가하다시스템 변수 " 길" Python 및 Saxon이 설치된 경로(예: " C:\Python23\;C\Saxon655\")(이 작업은 "내 컴퓨터"를 통해 수행되며 그 안에는 " 환경 변수", 경로는 세미콜론으로 구분하여 추가해야 합니다.) Saxon을 추출한 폴더에서 BAT 파일이름 포함 saxon.bat다음 내용으로:

@자바 항아리 "<путь к папке с Saxon>\saxon.jar"% 1 % 2 % 3

실행할 필요가 없습니다. XMLDoc이 있는 폴더에 BAT 파일을 만듭니다. start.bat헛소리하지 않기 위해 명령줄, 그리고 그 안에 다음을 작성합니다.

Cls xmldoc.py "<путь к папке с проектом>" 정지시키다

예제 경로는 "C:\Projects\TestProject"입니다. 중요한: 사용되는 모든 경로에는 키릴 문자가 포함되어서는 안 됩니다. 그렇지 않으면 XMLDoc에 문제가 발생합니다.이제 모든 것이 준비되었으며 start.bat 파일을 실행할 수 있습니다. 모든 것이 잘 진행되면 프로젝트 폴더에 폴더가 나타납니다 문서, 그리고 그 안에 - 결정적인어디에 저장될지 HTML 파일생성된 문서. 이것이 내가 얻은 것입니다(예를 들어 OpenTables 방법을 사용하여):

에 의해 주관적인 평가 이 옵션첫 번째 것보다 더 예뻐 보이네요. 다 좋은 것 같은데, XMLDoc도 부주의하게 링크를 잘랐다는 사실이 더 짜증납니다. . 이 HTML 파일은 최종 버전이 아니라는 점에 유의해야 합니다. 이 파일은 도움말 2.0 형식으로 변환될 수 있습니다(이론적으로는 변환되어야 합니다)(그런 다음 다음을 통해 볼 수 있음). 문서 탐색기, Delphi 또는 Visual Studio의 도움말과 동일). 이렇게 하려면 Visual Studio 도움말 통합 키트와 CodeGear HelpKit이 필요합니다. 더 이상 용기가 없었고 원칙적으로 결과가 이미 명확했기 때문에 더 이상 진행하지 않았습니다. 아마도 당신은 더 강해질 것입니다 :)

Doc-O-Matic Express를 사용하여 문서 생성하기

Doc-O-Matic- 충분한 강력한 유틸리티문서를 작성하기 위해 XML 기반및 JavaDoc 주석 HTML 형식, CHM 및 도움말 2.0. 그러나 불행히도 정식 버전은 유료입니다. 그러나 모든 것이 그렇게 나쁘지는 않습니다. Express 버전이 있으며(아마도 Microsoft에서 이름을 따온 것 같습니다) 필요한 거의 모든 것이 포함되어 있습니다. 한번 시험해 봅시다.

Doc-O-Matic을 사용하면 XMLDoc만큼 탬버린을 들고 춤을 추지 않아도 되지만 몇 번의 클릭만으로 끝낼 수는 없습니다. 섹션에서 유틸리티를 실행하십시오. 프로젝트 파일버튼을 클릭하세요 추가하다, 대화 상자 필터에서 선택 델파이 2007 프로젝트그리고 열어 필수 파일프로젝트. 탭에서 HTML섹션에 주목하세요 파일 및 폴더— 여기에서 문서 파일을 저장할 폴더를 지정할 수 있습니다. 예를 들어 C:\mydoc.dox-express 파일과 같은 편리한 위치에 설정을 저장합니다. 이제 유틸리티를 닫고 Doc-O-Matic이 설치된 폴더로 이동하십시오. 다음 줄을 사용하여 BAT 파일을 만듭니다.

Domexpress.exe -config "HTML"<путь к файлу *.dox-express>"

이 명령을 실행하면 문서 파일이 위에서 지정한 폴더에 배치되고 브라우저가 자동으로 시작됩니다. 예를 들어 메소드 설명은 다음과 같습니다.

다시 말하지만, 주관적으로는 그러한 도움이 가장 좋은 인상을 줍니다. 추가 포인트 없음 편리한 네비게이션. "TMainForm"이라는 단어에 대한 링크가 부족하여 인상이 약간 손상되었지만 적어도 Doc-O-Matic은 이전 두 유틸리티와 달리 이를 잘라내지 않았습니다.

후문 대신. Delphi의 코드 편집기 수준에서 XML 주석을 지원하는 것은 훌륭하고 편리한 기능이므로 꼭 사용해야 합니다. 그러나 문서를 생성하면 상황이 더욱 복잡해집니다. 표준 수단쉽게 사용할 수 없을 정도로 원시적입니다(그리고 솔직히 말해서 비뚤어졌습니다 =). 하지만 이 작업을 아주 잘 수행하는 Doc-O-Matic Express 형태의 대안이 있습니다. 곧(새 버전의 Delphi가 출시되면) 새롭고 더욱 유연한 유틸리티가 나타날 수 있기를 바랍니다.

주석은 프로그램 코드에 전혀 영향을 주지 않는 텍스트입니다. 절대로 컴파일하거나 붙여넣지 않습니다. 실행 가능 파일이지만 코드 설명에만 사용됩니다.

댓글은 두 가지 방법으로 형식을 지정할 수 있습니다.

1. 이중 슬래시 뒤에 오는 모든 것 // , 댓글로 인식됩니다.
   (이 방법으로 하나의 주석 줄만 형식화할 수 있습니다.)
2. 중괄호( 및 )로 묶인 내용도 주석입니다.
   (이 경우 주석에 원하는 만큼 줄을 포함할 수 있습니다.)

코멘트 예

이 댓글은 더 이상 댓글이 아닙니다.

(이건 또 댓글이네
그리고 이것도)

이 기사에서는 설명된 프로그램의 코드를 설명하기 위해 지속적으로 주석을 사용할 것입니다. 그렇기 때문에 코드 분석을 시작하기 전에 이들을 알아야 했습니다.

이제 Delphi 프로그래밍 언어를 배울 준비가 되었습니다. 만들다 새 프로젝트. 그런 다음 코드 편집기로 이동하십시오. 미래 프로그램의 개요는 이미 여기에 작성되어 있습니다.

여기에 쓰여진 내용을 자세히 살펴 보겠습니다. 다음은 생성된 템플릿의 각 라인에 대한 자세한 설명입니다. 그러나 프로그램 코드를 쉽게 공부할 수 있도록 여기에는 뭔가가 빠졌습니다.

Delphi 쉘 생성 템플릿

상호 작용

용도 //이 단어 뒤에는 연결된 모듈 목록이 있습니다.
Windows, 메시지, SysUtils, 변형, 클래스, 그래픽, 컨트롤, 양식,
대화;

유형 //다음에는 유형 선언이 옵니다.
TForml = 수업(TForm) //새 TForm 객체의 설명을 시작합니다. 양식 구성 요소 및 이벤트는 여기에 설명되어 있습니다.
사적인 //이 단어 뒤에는 객체의 개인 데이터를 설명할 수 있습니다.
(개인 선언)
TForml 객체에만 사용 가능
공공의 //이 단어 뒤에는 객체의 공개 데이터를 설명할 수 있습니다.
(공개 선언) //Delphi에서 생성된 힌트입니다. 여기서는 변수와 메소드를 설명할 수 있습니다.
다른 모듈에서 접근 가능
끝; //타입 선언 끝

var //전역변수 선언
형식: TForml; //TForml 객체 유형의 Forml 변수를 설명합니다.

구현

($R *.dfm) //Connect.dfm 파일(시각적 개체에 대한 데이터가 포함된 파일)

끝. // 점으로 끝납니다 - 모듈의 끝

불분명한 부분이 남아 있다면 생성 과정에서 실제 프로그램모든 것이 제자리에 들어갈 것입니다. 불가능하기 때문에 모든 것을 한꺼번에 기억하려고 하지 마십시오. 너무 많은 새로운 정보, 실제로는 지원되지 않습니다. 작성된 프로그램의 의미만 이해하려고 노력하십시오.

거의 모든 줄은 " ; "(세미콜론). 이 기호는 문의 끝을 나타냅니다. 문의 뒤에만 사용되며 다음과 같은 키워드 뒤에는 사용되지 않습니다.

사용, 유형, 시작, 구현, 비공개, 공개

등. 그 후, 당신은 모든 키워드에 익숙해질 것이며, 그 중 대부분은 눈에 띕니다. 굵은 글씨로. 예외는 즉시 표시됩니다. 모듈의 마지막 예외입니다. 끝, 세미콜론 대신 마침표가 옵니다.

그럼 코드의 구조를 살펴보겠습니다. 맨 처음에는 모듈 이름이 있습니다. 무엇이든 가능하지만 파일 이름과 동일합니다(확장자를 고려하지 않음). 모듈 이름을 수동으로 변경하는 것은 바람직하지 않습니다. 그래도 변경해야 하는 경우 먼저 이전 이름으로 모듈을 저장하세요. 이렇게 하려면 메뉴 명령을 선택합니다. 파일 | 다른 이름으로 저장(파일 | 다른 이름으로 저장).

모듈을 제공하는 것이 좋습니다 명확한 이름. 이 경우 같은 이름의 모듈 안에 무엇이 있는지 이름으로 확인할 수 있습니다. Unitl.pas라는 파일에 무엇이 있는지 추측하기는 어렵습니다. 또한 내용과 관련된 파일 이름을 지정하는 것이 좋습니다. 예를 들어, 주요 형태 MainUnit.pas 또는 MainModule.pas라는 파일에 프로그램을 저장하는 것이 좋습니다. 이 경우 모듈과 파일의 이름은 MainUnit 또는 MainModule로 지정되며 이것이 기본 폼인지 즉시 확인할 수 있습니다.

다음은 글로벌 모듈의 연결입니다. 모든 프로시저, 함수, 상수는 일부 모듈에 설명되어 있으며 이러한 프로시저를 사용하기 전에 연결해야 합니다. 함수가 존재한다는 것을 알 수 있습니다. 그러나 컴파일러가 이를 알 수 있도록 하려면 이 함수가 컴파일러가 이해할 수 있는 언어로 설명되는 모듈을 지정해야 합니다. 예를 들어 숫자를 문자열로 변환해야 합니다. 델파이에는 이미 이를 위한 IntTostr 함수가 있습니다. Sysutils 모듈에 설명되어 있습니다. 이 기능을 사용하려면 이 모듈을 Forms 모듈에 연결해야 합니다(사용 섹션에 Sysutils 이름 입력).

파티션에는 네 가지 유형이 있습니다.

1. 사적인- 이 섹션의 속성과 메서드는 이 개체에만 사용할 수 있습니다. 다른 객체는 이러한 메서드와 읽기/쓰기 속성을 호출할 수 없습니다.
2. 보호됨- 이러한 속성과 메서드는 이 객체와 그 자손(우리의 자손이며 해당 속성을 상속하는 객체)에서만 사용할 수 있습니다. 타사 개체는 여기에 저장된 속성 및 메서드에 액세스할 수 없습니다.
3. 공공의- 여기에 설명된 모든 내용은 누구나 사용할 수 있습니다.
4. 게시됨- 언제 오줌을 누나요? 자체 구성 요소이 섹션에서는 개체 검사기에 표시되어야 하는 속성과 이벤트에 대해 설명합니다. 이러한 속성은 모든 사람이 사용할 수 있습니다.

객체와 해당 구성 요소의 선언 후에는 전역 변수에 대한 설명이 있습니다. 키워드 다음에 시작됩니다. var항상 유형 선언 뒤에 옵니다. 이제 이 부분을 기억해야 합니다. 먼저 섹션이 나오니까요. 유형, 유형이 설명되어 있는 곳 var, 변수가 설명되어 있습니다.

전역 변수는 스택에 저장되어 프로그램이 시작될 때 생성되고 프로그램이 종료될 때 소멸되는 변수입니다. 이는 프로그램이 실행되는 동안 언제 어디서나 사용할 수 있음을 의미합니다.

전역 변수 선언의 예

이 예에서는 TForml 유형의 Forml 변수를 선언합니다. TForml 객체가 생성되면 해당 포인터가 Form1 변수에 기록됩니다. 이 변수는 전역 변수이며 프로그램이 실행되는 동안 존재하므로 언제든지 액세스할 수 있습니다.

예어 구현지금은 이에 대해 다루지 않겠지만, 델파이에 대한 우리의 지식이 조금 더 확장되는 미래를 위해 남겨두겠습니다. 이 장에서 마지막으로 다루게 될 것은 키($R * dfm)입니다.

중괄호에는 주석뿐만 아니라 컴파일러 스위치도 포함될 수 있습니다. ($Letter Parameter]와 유사하다는 점에서 다릅니다. Letter - 키 유형을 나타냅니다. 우리의 경우 문자가 사용됩니다. 아르 자형. 이 키는 리소스 파일을 이 경우 .dfm모듈 이름과 동일한 이름을 가진 파일(시각적 개체에 대한 데이터가 포함된 파일)입니다. 모듈 이름인 경우 본체, 이 키를 ($R로 변경해야 합니다. 본체.dfm). 열쇠 아르 자형- 현재 필요한 유일한 열쇠입니다.

어느 프로그램 코드델파이에서는 시작과 끝 사이에 있습니다. 예어 시작하다코드의 시작을 의미합니다. 끝- 끝. 예를 들어, 프로시저를 작성할 때 먼저 프로시저 이름을 작성한 다음(이 작업을 수행하는 방법은 나중에 설명하겠습니다) 시작 및 끝 연산자 대괄호 사이에 해당 코드를 묶어야 합니다.

사이트 자료를 기반으로

페이지 5/9

코멘트

오브젝트 파스칼 언어는 블록 주석과 단일 라인 주석이라는 두 가지 유형의 주석을 지원합니다. 주석 사용에 대한 일반적인 고려 사항은 다음과 같습니다.

• 모듈 시작 부분에 설명을 추가하여 목적을 설명합니다.
• 클래스 선언 앞에 주석을 놓으십시오.
• 메소드 선언 앞에 주석을 놓으십시오.
• 뻔한 댓글은 피하세요. (i:= i + 1 // i에 1을 더함);
• 오해의 소지가 있는 댓글은 댓글을 달지 않는 것보다 더 나쁘다는 점을 기억하세요.
• 시간이 지남에 따라 정확하지 않을 수 있는 정보를 댓글에 입력하지 마세요.
• 별표나 기타 기호로 주석을 장식하지 마세요.
• 임시(릴리스 중이 아닌) 주석의 경우 "TODO"를 사용하세요.

댓글 차단

오브젝트 파스칼은 두 가지 유형의 블록 주석을 지원합니다. 가장 일반적으로 사용되는 블록 주석은 쌍입니다. 중괄호: { } . Delphi 팀은 이 설명을 가능한 한 단순하고 대체적으로 유지하는 것을 선호합니다. 이러한 주석의 텍스트 형식을 지정하려면 공백을 사용하고 별표 "*"를 사용하지 마십시오. 줄 바꿈 시 들여쓰기와 정렬을 유지해야 합니다.

DsgnIntf.pas의 예:

블록 주석에는 항상 모듈에 대한 정보(저작권, 수정 날짜 등)가 포함됩니다. 메소드를 설명하는 블록 주석은 메소드 선언 앞에 와야 합니다.

두 번째 유형의 블록 주석에는 괄호와 별표라는 두 문자가 포함됩니다. (* *) . 이 유형의 주석은 개발 중에 사용됩니다. 소스 코드. 장점은 중첩된 주석을 지원한다는 것입니다. 다른 유형. 이 속성을 사용하여 다른 주석이 포함된 큰 코드 덩어리를 주석으로 처리할 수 있습니다.

한 줄 주석

한 줄 주석은 // 문자와 주석 텍스트로 구성됩니다. // 문자 뒤에는 공백과 텍스트가 와야 합니다. 한 줄 주석은 해당 주석이 표시된 코드와 동일하게 들여쓰기되어야 합니다. 한 줄 주석을 그룹화하여 양식을 만들 수 있습니다. 좋은 댓글.

한 줄짜리 주석은 다음과 같이 시작할 수 있습니다. 새 줄주석이 달린 코드를 계속할 수 있습니다. 이 경우 코드와 주석 사이에는 공백이 하나 이상 있어야 합니다. 코드 뒤에 주석이 두 개 이상 있으면 동일한 열에 정렬해야 합니다.

한 줄 주석의 예:

모듈의 각 줄에 대한 코드에 주석을 사용하지 않아야 합니다.

페이지 7/12

클래스

클래스 본문 구조

선언된 클래스의 본문은 종속됩니다. 다음 구조:

• 필드 선언
• 방법 선언
• 속성 선언.

액세스 수준

• 비공개(숨겨진) 클래스 멤버( 사적인);
• 보호된 클래스 멤버( 보호됨);
• 공개 클래스 멤버( 공공의);
• 게시된 클래스 멤버( 출판됨)

따라서 오브젝트 파스칼에는 가시성이 낮은 순서대로 게시됨, 공개됨, 보호됨, 비공개라는 네 가지 클래스 멤버 액세스 수준이 있습니다. 기본적으로 액세스 수준이 게시됩니다. 일반적으로 반원에게는 해당 구성원에게 적합한 가장 낮은 수준의 액세스 권한이 부여되어야 합니다. 예를 들어, 동일한 모듈의 클래스에서 액세스할 수 있는 멤버의 액세스 수준은 private이어야 합니다. 또한 액세스 수준이 가장 낮은 클래스 멤버를 선언하면 컴파일러가 다음을 활용할 수 있습니다. 추가 기능최적화를 위해. 반면, 앞으로 생산할 계획이라면 어린이 수업수업에서 레벨을 사용해야합니다. 접근 보호됨.

레벨을 지정하지 마십시오. 공개 액세스데이터용. 데이터는 항상 비공개 섹션에서 선언되어야 하며 메서드나 속성을 사용하여 액세스해야 합니다.

생성자 선언

메소드 선언