[Suggestion:]Naming conventions in AHK document

Share your ideas as to how the documentation can be improved.
User avatar
V2User
Posts: 219
Joined: 30 Apr 2021, 04:04

[Suggestion:]Naming conventions in AHK document

14 Jul 2023, 03:19

Currently almost every element does start with an uppercase letter in AHK's document, which may result in many people as well as V2 edit extensions imitating the unintentional 'style' from the document.
;) A maybe proper suggestion:
Start with a lowercase letter for obj's property names like obj.base and keywords like if,return.etc.
Still start with an uppercase letter for class names, function names and method names.
Last edited by V2User on 15 Aug 2023, 08:42, edited 4 times in total.
just me
Posts: 9763
Joined: 02 Oct 2013, 08:51
Location: Germany

Re: [Suggestion:]Naming conventions in AHK document

14 Jul 2023, 03:23

Hi,

that's a matter of personal taste. I prefer the 'uppercase style'. ;)
User avatar
emmanuel d
Posts: 97
Joined: 17 Nov 2013, 04:45

Re: [Suggestion:]Naming conventions in AHK document

11 Sep 2023, 08:02

Naming like:

Code: Select all

FileMove SourcePattern, DestPattern [, Overwrite]
That is like pretending commands stil exist. :shock: it should have bin removed from the getgo.
Now it is unclear what is a function an what isn't. Just because it returns no value is no reason to write it like a command.
when converting to v2 we have to convert most of the parameters anyway
use:

Code: Select all

FileMove(SourcePattern, DestPattern [, Overwrite])
ComObjQuery(ComObj, [SID,] IID)
also, note the [ is in the wrong parameter, only in a few cases in the manual is it in the wright place.
that requires extra clicking and selecting on copy paste, realy not efficient :facepalm:
so preferably:

Code: Select all

FileMove(SourcePattern, DestPattern, [Overwrite])

Return to “Suggestions on Documentation Improvements”

Who is online

Users browsing this forum: No registered users and 8 guests