Naming conventions¶
For the sake of clarity in this multi-language documentation, the following naming conventions have been adopted.
Class, struct and enumeration names are written in PascalCase. Example:
License.Class and struct member names are written in lowerCamelCase. Example:
activateSerialKeyEnumeration fields are written in lowerCamelCase. Example :
LicenseError.invalidLicense.
Warning
The naming convention adopted in this documentation does not necessarily reflect the convention for a given programming language. More information is given below.
Conventions for Python¶
This SDK complies with the PEP 8 recommendations.
Class, struct and enumeration names are written in PascalCase.
Class and struct member names are written in snake_case.
Enumeration fields are written in UPPER_CASE_WITH_UNDERSCORE.
Examples:
Class name:
LicenseFunction name:
activate_serial_keyStructure:
FacePointEnumeration field:
LicenseError.INVALID_LICENSE
Conventions for Dart¶
Class, struct and enumeration names are written in PascalCase.
Class and struct member names are written in lowerCamelCase.
Enumeration fields are written in lowerCamelCase.
Examples:
Class name:
LicenseFunction name:
activateSerialKeyStructure:
FacePointEnumeration field:
LicenseError.invalidLicense
Conventions for C#¶
Class, struct and enumeration names are written in PascalCase.
Class and struct member names are written in PascalCase.
Enumeration fields are written in PascalCase.
Examples:
Class name:
LicenseFunction name:
ActivateSerialKeyStructure:
FacePointEnumeration field:
LicenseError.InvalidLicense
Conventions for Java¶
Class name:
LicenseFunction name:
activateSerialKeyStructure:
FacePointEnumeration field:
LicenseError.INVALID_LICENSE
Conventions for Kotlin¶
Class name:
LicenseFunction name:
activateSerialKeyStructure:
FacePointEnumeration field:
LicenseError.INVALID_LICENSE
Conventions for Swift¶
Class name:
LicenseFunction name:
activateSerialKeyStructure:
FacePointEnumeration field:
LicenseError.invalidLicense
Conventions for C/C++¶
Class name:
id3License_Function name:
id3License_ActivateSerialKeyStructure:
id3FacePointEnumeration field:
id3LicenseError_InvalidLicense
Note
The C API implements pseudo object-oriented programming concepts where the object is passed explicitly to a member function as first parameter.