델파이 및/또는 프리 팩 칼 코드의 가장 일반적인 문서 블록

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

문제

나는 지난 15 년 이상 내 일 이었기 때문에 PHP Dockblocks에 대해 매우 익숙합니다.

/**
  * Description
  *
  * @tag bla bla
  * @tag more bla bla
  */

내가 이해하려고하는 것은 델파이 및/또는 프리파 스칼의 표준이 있는지 여부입니다.

끔찍한 코드에 대한 내 분석에서 나는 결코 본 적이 없지만 죽을 수있었습니다.

도움이 되었습니까?

해결책

델파이 문서 도구

API 문서에 XMLDOC 도구 사용 및 Delphi 2005와의 도움말http://edn.embarcadero.com/article/32770

Delphi 2006의 XML 문서http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html

delphicodetodochttp://dephicodetodoc.sourceforge.net/

doc-o-matichttp://www.doc-o-matic.com/examplessourcecode.html

PASDOChttp://pasdoc.sipsolutions.net/

파스칼 브라우저http://www.peganza.com/

독사http://www.doxygen.nl/

pas2doxhttp://sourceforge.net/projects/pas2dox/

Jadd- 또 다른 Delphidochttp://delphidoc.sourceforge.net/

stackoverflow 토론

현재 Delphi 구문을 지원하는 Delphi Code Documentor가 있습니까?https://stackoverflow.com/questions/673248/is-there-a-delphi-code-documentor-that-supports-current-delphi-syntax

Javadoc 또는 C# xml doc과 유사한 Delphi에 대한 코드 문서Javadoc 또는 C# xml doc과 유사한 Delphi에 대한 코드 문서

델파이 문서화https://stackoverflow.com/questions/33336/documenting-delphi

다른 팁

최신 Delphis는 XML 문서의 구문 분석을 지원합니다. 또한이 정보를 힌트로 사용합니다 (예 : 마우스 커서를 메소드 이름으로 이동하는 경우).

메소드 문서 에이 템플릿을 사용하고 있습니다.

///<summary></summary>
///<param name=''></param>
///<returns></returns>
///<exception cref=""></exception>
///<since>2009-04-15</since>

나는 소스 외부의 문서를 선호하고 (항상 지저분 해지고 있음) FPC와 함께 제공되는 우수한 FPDOC를 사용합니다. (FPC의 자체 문서는 작성됩니다).

현재 진행중인 프로젝트에서 우리는 delphicodetodoc, 합리적으로 잘 작동합니다. 구문은 다음과 같습니다.

type
  {* This is an example class }
  TMyClass = class
  private
  protected
  public
    {* Does some twiddling with AParam, and returns the result as String
       @param AParam Input value
       @return AParam incremented by 2, as String
       @throws Exception 'Boo' if it's full moon }
    function MyFunction(AParam: Integer): String;
  end;

Doxygen에 도구가있는 것처럼 보입니다 함께 사용할 수 있습니다 Pascal 및 Delphi 코드를 문서화하십시오. 어쩌면 그것은 당신을 도울 것입니다.

일반적으로 사용중인 문서 도구에 따라 여러 표준이 있습니다. 우리는 PASDOC를 사용하므로 주로 그 형식을 고수합니다. http://pasdoc.sipsolutions.net/ Javadoc을 기반으로합니다.

또는 GABR이 지적한 것처럼 XMLDOC가 있으며, 다른 도구가 거의 있으며, 대부분 미묘한 차이가있는 비슷한 구문이 있습니다.

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