Документ Delphi DLL Exports

Question

У меня есть DLL со многими функциями экспорта, которые я хотел бы поделиться с другими людьми. Есть ли способ документировать все существующие функции экспорта с параметрами, результатами и т. Д., Чтобы я мог делиться ими с другими, не записывая их самостоятельно?

Answer 1

Если вы используете более позднюю версию Delphi, такую ​​как XE2, у вас может быть Documentation Insight, который я только что подтвердил, работает для экспортируемых функций. В своем коде нажмите на определение функции/процедуры. Скажем, к примеру ...

procedure DoIt(One: Single; Two: Integer); stdcall; 
begin 
    //some other code 
end; 

После того, как вы нажали на это, и курсор находится в пределах этой функции, нажмите комбинацию CTRL + ALT + D. Если у вас есть эта функция документации, она откроется небольшим окном, такие как ...

После ввода некоторых документов в это окно, он будет автоматически вставить это в ваш код:

/// <summary> 
/// This procedure does this and then that 
/// </summary> 
/// <param name="One"> 
/// This is parameter one 
/// </param> 
/// <param name="Two"> 
/// This is parameter two 
/// </param> 
/// <remarks> 
/// Use DoIt to do this and that within your Delphi project. 
/// </remarks> 
procedure DoIt(One: Single; Two: Integer); stdcall; 
begin 
    //some other code 
end; 

Refer here для получения дополнительной информации о том, как использовать эту документацию, а также this one.

Что можно использовать в любом месте вашего источника, вы наведите указатель мыши на один из ваших документированных классов, функций, типов и т. Д., Он покажет небольшое окно подсказки с вашей документальной информацией. Что касается использования в DLL, я никогда не делал этого, но я уверен, что вы тоже можете его использовать.

Вы также можете свободно вводить этот формат документации непосредственно в свой код без использования этого окна - так что в основном вы можете сделать это на любой версии Delphi. Это стандартный формат Microsoft, который также используется на других языках.

К сожалению, я не уверен, какие версии/выпуски Delphi поддерживают его.