Guidelines for Creating Libraries

Libraries must be created according to specific rules to avoid compatibility issues.

The main items include the following:

  • Define a meaningful library name (required)
  • Use templates to ensure consistency (optional)
  • Use a familiar and uniform project structure, when possible (optional)
  • Register a unique global library namespace (required)
  • Enter all project information (required)
  • Reference other libraries correctly (required)
  • Implement usable external and internal interfaces (required)
  • Implement a user-friendly error management (required)
  • Apply the appropriate methods (protection) for deployment (required)
  • Apply a consistent naming convention to obtain clean code (optional)
  • When revising an existing library, consider the interface compatibility with previous versions.

See also