Function usage document as comments

ahkscript / libcrypt.ahk

A collection of crypting and encoding functions from the community

MIT License

66 stars 19 forks source link

Closed joedf closed 9 years ago

joedf commented 9 years ago

The function usage should have a standard format of documentation as a short comment over each function in its lib file.

Suggested format:

Description : [tab] ...
Usage : [tab] param1 - the input string to be ...
[tab] [tab?] param2 - ...

Thoughts?

G33kDude commented 9 years ago

What about the GenDocs project? Perhaps we should consider following its format?

joedf commented 9 years ago

Perfect.