Modify

Opened 10 years ago

Closed 10 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 Changed 10 years ago by TicketCleanup

  • Version 3.3.0.0 deleted

Automatic ticket cleanup.

comment:2 Changed 10 years ago by Valik

  • Resolution set to Rejected
  • Status changed from new to 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.

Guidelines for posting comments:

  • You cannot re-open a ticket but you may still leave a comment if you have additional information to add.
  • In-depth discussions should take place on the forum.

For more information see the full version of the ticket guidelines here.

Add Comment

Modify Ticket

Action
as closed The ticket will remain with no owner.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.