This is an automated email from the ASF dual-hosted git repository. joshtynjala pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit 5e5de263a2c81b38f83f0878c7fbf2e6a845a66b Author: Josh Tynjala <[email protected]> AuthorDate: Wed Jun 11 09:47:20 2025 -0700 code-conventions: format some names that are code and minor tweaks --- features/as3/code-conventions.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/features/as3/code-conventions.md b/features/as3/code-conventions.md index 2530ca7..9db39fb 100644 --- a/features/as3/code-conventions.md +++ b/features/as3/code-conventions.md @@ -28,27 +28,27 @@ Coding standards for writing code in ActionScript 3 ## Packages -Packages have lower.case.names separated by periods if needed. Names using mixedCase (starting with lower case) are ok, but short package names are preferred so that you aren't tempted to mixCase. +Packages have `lower.case.names` separated by periods, if needed. Names using `mixedCase` (starting with lower case) are ok, but short package names are preferred so that you aren't tempted to mixCase. ## Classes -Classes have MixedCase names starting with a capital letter (and no hyphens). +Classes have `MixedCase` names starting with a capital letter (and no hyphens). If a name contains an acronym, each letter in the acronym should be entirely capitalized, like HTML in `HTMLElement`. ## Constants -Constants have CAPITALIZED_NAMES with words separated by underscores '_'. +Constants have `CAPITALIZED_NAMES` with words separated by underscore (`_`) characters. ## Properties -Properties have mixedCase names starting with a lower case letter. +Properties have `mixedCase` names starting with a lower case letter. ## Events -Events have mixedCase names starting with a lower case letter. +Event strings have `mixedCase` names starting with a lower case letter. ## Event Classes -While Apache Flex had lots of event classes, Royale strives to have as few as possible since each class has download overhead. Royale has an Event which has an event name in the "type" field and no other payload. A ValueEvent contains one item that might be of interest to the listener. ValueChangeEvent has oldValue/newValue. There may be a StringEvent and other 'typed' event classes. +While Apache Flex had lots of event classes, Royale strives to have as few as possible since each class has download overhead. Royale has an `Event` which has an event name in the `type` field and no other payload. A `ValueEvent` contains one item that might be of interest to the listener. `ValueChangeEvent` has `oldValue`/`newValue`. There may be a `StringEvent` and other "typed" event classes. Event constants go in the class that will dispatch the event. Thus the developer only has to import one class and write the code that uses it.
