javadoc 또는 C# xml doc와 유사한 델파이용 코드 문서

StackOverflow https://stackoverflow.com/questions/236047

  •  04-07-2019
  •  | 
  •  

문제

델파이 코드용 javadoc 또는 C# xml doc와 유사한 코드 문서화 도구가 필요합니다.가장 좋은 도구는 무엇입니까?저는 미래에 Microsoft sandcastle 프로젝트와 호환되는 기술을 선호합니다.

도움이 되었습니까?

해결책

보세요 synproject, 델파이로 작성된 오픈 소스 도구.

테스트, 아키텍처 및 디자인을 포함한 사양에서 릴리스 노트에 이르기까지 전체 문서 워크 플로우를 처리하도록 설계되었습니다. 물론 기존 델파이 소스 코드에서 아키텍처 문서를 생성하기위한 통합 델파이 파서가 있습니다.

아키텍처 문서의 경우 소스 코드는 주석 (ALA PASDOC)을 추출한 다음이 텍스트를 기본 아키텍처 문서 (클래스 계층 다이어그램 및 단위 종속성 포함)에 포함시킬 수 있습니다.

전용 텍스트 편집기에 위키 같은 구문을 사용하여 일반 텍스트 파일을 작성한 다음 SynProject는 잘 구성된 Word 문서를 작성합니다. 일부 마법사는 콘텐츠에 액세스 할 수 있습니다. 그러나 일반 파일로 저장되므로 여러 프로그래머가 SCM 도구 (SVN, 화석 ...)를 사용하여 작성할 수 있습니다.

예를 들어, 현재 사용 가능한 문서가없는 거대한 오래된 델파이 응용 프로그램 (델파이 5 및 6로 작성된 약 2,000,000 줄의 코드 라인)에 대한 유지 보수 문서를 작성하는 데 사용하고 있습니다. 코드의 변경 사항 (단위/클래스/메소드를 인용함으로써)을 설명하면 도구는 모든 문서를 업데이트하여 해당 수정을 반영하고 추적합니다. SynProject는 일부 "섬세한"규정 규칙 (IEC 62304)을 준수하도록 설계되었지만 고유 한 "플랫"디자인으로 인해 모든 프로젝트에 사용할 수 있습니다.

메모: SynProject가 현재 존재하지 않았으며 볼 가치가 있기 때문에 질문 후 오랫동안 게시하고 있습니다. 이 스레드 그 질문에 대한 참조로 정의되었습니다.

다른 팁

delphi + javadoc = delphicodetodoc

내가 아는 한, Microsoft Sandcastle과 쉽게 호환되는 도구는 없습니다. 적어도 누군가가 실제로 하나를 작성하거나 기존을 수정하거나 출력을 올바르게 변환하기 위해 도구 체인을 만들 때까지 도구는 없습니다.

나는 개인적으로 사용했습니다 PASDOC 큰 성공으로. 현재 릴리스가 때때로 복잡한 인터페이스 정의에 크로크를 찍기 때문에 최신 SVN 버전을 구축하는 것이 좋습니다.

노력하다: - 독사 문서 - pas2dox

Delphi 2005부터는 Delphi 컴파일러에서 빌드되었습니다.XML 스타일 주석을 사용하는 XMLDoc 표준을 사용합니다.C#과 마찬가지로 Sandcastle도 이를 처리할 수 있을 것 같습니다.보다 http://dn.codegear.com/article/32770 그리고 http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html

또한 참조하십시오 델파이 문서화

Sandcastle은 문서를 생성하기 위해 어셈블리에 액세스해야합니다. 이는 .NET 언어에만 적용 가능하다는 것을 의미합니다 (Delphi.net은 확실하지는 않지만). 그러나 Delphi 2007 및 2009에는 C#과 매우 유사한 인라인 XML 문서가 있습니다. 프로젝트 옵션에서 'XML 문서 생성'옵션을 켜면 이러한 주석을 기반으로 XML 문서를 작성합니다. 그런 다음 XSLT를 사용하여 필요한 문서 형식을 생성 할 수 있습니다 (어려운 비트입니다).

delphicodetodoc 또한 연속 통합 도구 (예 :)와 함께 사용하도록 명령 라인이 있습니다.

질문은 꽤 오래되었지만 오늘도 같은 문제가 있었고이 게시물을 찾았습니다. Delphi 2007은 다음 구문을 허용합니다.이 구문은 C# 문서와 동일합니다.

/// <summary>
/// Summary of the function / class
/// </summary>
/// <param name="param1">Description of the parameter param1</param>
/// <param name="param2">Description of the parameter param2</param>
/// <param name="param3">Description of the parameter param3</param>
/// <returns>Description of the return value</returns>
function test(param1, param2, param3: string): string;

을 위한 <summary>, 라인 브레이크를 허용 할 가능성이없는 것 같습니다. <br /> 작동하지 않습니다.

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top