I am in the process of revising my reusable code modules. This also includes the documentation of the interfaces.
Currently I use code comments that can be evaluated with doxygen. Unfortunately these are not very readable in the code.
Doxygen
URL: https://www.doxygen.nl/
Example:
Result as HTML:
Some time ago I discovered Natural Docs.
Does anyone use it?
It makes the comment in the code much easier to read.
Natural Docs
URL: https://www.naturaldocs.org/
Example:
Result as HTML (Is just a test, there are still many doxygen comments included that Natural Docs cannot format.):
The output is not as extensive as doxygen, but maybe I'm overlooking other possible optimizations.
Does anyone know of any other documentation tools that can generate documentation form source code?
Currently I use code comments that can be evaluated with doxygen. Unfortunately these are not very readable in the code.
Doxygen
URL: https://www.doxygen.nl/
Example:
Code:
'---------------------------------------------------------------------------------------
' Function: BuildCriteria
'---------------------------------------------------------------------------------------
'/**
' <summary>
' Create SQL criteria string
' </summary>
' <param name="FieldName">Field name in the data source to be filtered</param>
' <param name="RelationalOperator">Relational operator (=, <=, etc.)</param>
' <param name="FilterValue">Filter value (can be a single value or an array of values)</param>
' <param name="FilterValue2">Optional 2nd filter value (for Between)</param>
' <param name="IgnoreValue">The value for which no filter condition is to be created. (Array transfer of values possible)</param>
' <returns>SQL criteria string</returns>
' <remarks>
' </remarks>
'**/
'---------------------------------------------------------------------------------------
Public Function BuildCriteria(ByVal FieldName As String, ByVal FieldDataType As SqlFieldDataType, _
ByVal RelationalOperator As SqlRelationalOperators, _
ByVal FilterValue As Variant, _
Optional ByVal FilterValue2 As Variant = Null, _
Optional ByVal IgnoreValue As Variant, _
Optional ByVal DisableIgnoreNullValue As Boolean = False) As String
...
Some time ago I discovered Natural Docs.
Does anyone use it?
It makes the comment in the code much easier to read.
Natural Docs
URL: https://www.naturaldocs.org/
Example:
Code:
'---------------------------------------------------------------------------------------
' Function: BuildCriteria
'---------------------------------------------------------------------------------------
'
' Create SQL criteria string
'
' Parameters:
' FieldName - Field name in the data source to be filtered
' RelationalOperator - Relational operator (=, <=, etc.)
' FilterValue - Filter value (can be a single value or an array of values)
' FilterValue2 - Optional 2nd filter value (for Between)
' IgnoreValue - The value for which no filter condition is to be created. (Array transfer of values possible)
'
' Returns:
' SQL criteria string
'
'---------------------------------------------------------------------------------------
Public Function BuildCriteria(ByVal FieldName As String, ByVal FieldDataType As SqlFieldDataType, _
ByVal RelationalOperator As SqlRelationalOperators, _
ByVal FilterValue As Variant, _
Optional ByVal FilterValue2 As Variant = Null, _
Optional ByVal IgnoreValue As Variant, _
Optional ByVal DisableIgnoreNullValue As Boolean = False) As String
...
The output is not as extensive as doxygen, but maybe I'm overlooking other possible optimizations.
Does anyone know of any other documentation tools that can generate documentation form source code?