2013-03-12 4 views
24

심각한 문서 작성이 필요한 코드 조각이있어서 C#/.NET의 인 코드 XML 문서와 유사한 기능이 Embarcadero Delphi에서 사용 가능한지 여부를 묻고 싶었습니다. 내 목표는 델파이 XE3의 자동 완성에서 강조 표시되는 방식으로 특정 메소드를 올바르게 사용하는 방법에 관한 정보를 표시하는 것입니다. 이 (C 번호) 등의델파이에서 메소드 주석 달기?

뭔가 :

/// <summary> 
/// Some useful information helping other developers use this method correctly 
/// </summary> 
public static void ADocumentedMethod(); 
이 같은

합니까 델파이 XE3 지원 무엇인가?

읽어 주셔서 감사합니다.

+0

어떤 Delphi XE3 배포 버전을 보유하고 있습니까? 이 정보를 질문에 포함시킬 수 있습니까? – TLama

+2

@TLama는 정말로 중요하지 않습니다. AFAIK /// XML-doc은 D2010부터 사용할 수 있습니다. 모든 SKU는 다소 버그가있는 것 같지만 ... – ain

+2

@ain, [Documentation Insight'] (http://edn.embarcadero.com/cs/article/41911) 내가 기억하는 한, 델파이의 값싼 배포판에서 상당히 큰 제약이있는 곳이 아닌가? – TLama

답변

32

이 기능의 이름은 입니다. XML 설명서 설명이며 documented here입니다. 동등한 .net 기능에 대해 면밀히 모델링 한 것으로 보이므로 집에 꼭 있어야합니다. 이 도움말 통찰력 힌트 결과

/// <summary> Removes the specified item from the collection 
/// </summary> 
/// <param name="Item">The item to remove 
/// </param> 
/// <param name="Collection">The group containing the item 
/// </param> 
/// <remarks> 
/// If parameter "Item" is null, an exception is raised. 
/// <see cref="EArgumentNilException"/> 
/// </remarks> 
/// <returns>True if the specified item is successfully removed; 
/// otherwise False is returned. 
/// </returns> 
function RemoveItem(Item: Pointer; Collection: Pointer): Boolean; 
begin 
    // Non-XML DOC comment 
    // ... 
end; 

:

문서는이 예를 포함

enter image description here

을 그리고 처리하고 문서를 소비하는 다양한 방법이 있습니다.

+1

이것은 완벽합니다! 고마워요! 나는 인터넷 검색을하면서 이것을 발견하지 못했기 때문에 약간 어리 석다. – FLClover

+0

또한이 XML 문서는 외부 장치에 표시하기 위해 장치의 '인터페이스'섹션에 있어야합니다. – Paul