Наиболее распространенный docblock для Delphi и/или кода FreePascal
Вы можете использовать десериализатор формата (например, JSON / XML), чтобы прочитать ввод и десериализовать его в заданную структуру.
В вашем случае вы бы определили класс с конкретными полями, которые вы ожидаете от этого входного файла. (В этом примере используется JSON, но принципы одинаковы независимо от формата записи)
public class Settings {
public int Brightness { get; set; }
public string Connection { get; set; }
}
И тогда вы бы десериализовались так
var settings = JsonConvert.DeserializeObject<Settings>(fileInput)
Десериализатор знает тип, потому что вы определили это. (Обратите внимание, что каждое поле не обязательно должно существовать для создаваемого типа.)
6 ответов
Инструменты документации Delphi
Использование инструмента XMLDoc для документации API и HelpInsight с Delphi 2005 http://edn.embarcadero.com/article/32770
Документация XML в Delphi 2006 http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html
DelphiCodeToDoc http://dephicodetodoc.sourceforge.net/
Док-O-Matic http://www.doc-o-matic.com/examplesourcecode.html [тысяча двести восемьдесят шесть] PasDoc http://pasdoc.sipsolutions.net/
Pascal Browser http://www.peganza.com/
Doxygen http://www.doxygen.nl/
Pas2Dox http://sourceforge.net/projects/pas2dox/
JADD - просто еще один DelphiDoc http://delphidoc.sourceforge.net/
Обсуждение Stackoverflow
Существует ли документатор кода Delphi, который поддерживает текущий синтаксис Delphi? https://stackoverflow.com/questions/673248/is-there-a-delphi-code-documentor-that-supports-current-delphi-syntax
Документация по коду для delphi, аналогичная 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>
В проекте, над которым я сейчас работаю, мы используем 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;
Я предпочитаю документы вне исходного кода (они всегда запутываются) и использую отличный fpdoc, который поставляется с FPC. (В нем написаны собственные документы FPC).
Существует несколько стандартов, обычно в зависимости от используемого инструмента документации. Мы используем PasDoc, поэтому мы в основном придерживаемся его формата http://pasdoc.sipsolutions.net/ , основанного на JavaDoc.
В качестве альтернативы есть XMLDoc, как указал Габр, и есть довольно несколько других инструментов, большинство из которых имеют похожий синтаксис с небольшими различиями.
Похоже, что у doxygen есть инструмент , который можно использовать вместе с документ Pascal и Delphi code . Может быть, это поможет вам.