Openmeetings LZX编码规范.docx

Openmeetings LZX编码规范(1) Naming Convention/p/openmeetings/wiki/CodingGuidelinesType Rules Examples class User-defined general class. Use lowerCamelCase for a class name myClass / private class User-defined private class. Use lowerCamelCase for a private class name. A private class is used only in the general class. _myPrivateClass / (2) Coding Rules/p/openmeetings/wiki/CodingGuidelinesRules in a class/p/openmeetings/wiki/CodingGuidelinesIf possible , do not use parent.something within a class in order to access the values outside of the class. Example: !-- NG --? class name=myClass?view width=${parent.parent.parent.width} /?/classDebug statement/p/openmeetings/wiki/CodingGuidelinesUse if($debug) Debug.write(.....) for the Debug statements. Just for a performance issue. Example: !-- Not Bad, but Not Recommended --handler name=onsomething? Debug.write(something,obj);?/handler?!-- OK --?handler name=onsomething? if($debug) Debug.write(something,obj);?/handlerClass File/p/openmeetings/wiki/CodingGuidelinesOne class per file, with filename same as classname. Small private classes only for the general class should be encapsulated in the same file. Example: !-- OK --?myClass1.lzx:??library??class name=myClass1 /??/library??!-- OK --?myClass1.lzx:??library??class name=myClass1 /?class name=_myPrivateClass1 /?== It is a class needed for myClass1 only??/library??!-- NG --?myClass1.lzx:??library??class name=myClass1 /?== general class??class name=myClass2 /?== second general class. But there must be *one* general class per file.??/libraryComments/p/openmeetings/wiki/CodingGuidelinesUse Lzxdoc style comment tags --- -- for class, attribute, method. We can generate the LZX Document from the comments. See also /LzxdocToolLzxdocTool Example: ?Normal comment: !-- normal comment --??For LzxDoc comment: !--- Lzxdoc comment -- == Notice! It has more than two Hyphens.Examples: !--- A layout specifically for toolbar buttons, with optional? automatic button collapsing.?? Sample usage:? @S