Opened 17 years ago
Closed 17 years ago
#1039 closed Feature Request (Rejected)
DocStrings?
| Reported by: | HydroXidE | Owned by: | |
|---|---|---|---|
| Milestone: | Component: | AutoIt | |
| Version: | Severity: | None | |
| Keywords: | docstrings python | Cc: |
Description
Could AutoIT feature DocStrings similar to Python?
It could feature a custom delimiter to define one or more DocStrings for a Function bound by certain rules. We could have a function in AutoIT to return the DocString from a specified function as a string. Could also be enhanced further to have multiple DocStrings
Considering the procedure oriented nature, implementations with large pieces of AutoIT code with several functions and includes could vastly benefit from this from a maintenance and documentation perspective. UDFs would definitely benefit largely from this. The Aut2EXE could also feature a switch whether to compile with DocStrings, or omit it for optimization (or perhaps check if the DocString return function is present anywhere in the code and decide about the switch).
Open for discussion.
Cheers,
Praveen (HydroXidE)
Attachments (0)
Change History (2)
comment:1 by , 17 years ago
| Version: | 3.3.0.0 |
|---|
comment:2 by , 17 years ago
| Resolution: | → Rejected |
|---|---|
| Status: | new → closed |
There is no need to build anything directly into AutoIt. Docstring-esque functionality can be obtained by specially formatted comments or pre-processor statements. A UDF can be written to parse the document and transform the output to whatever.

Automatic ticket cleanup.