Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Development Conventions and Guidelines"
| (4 intermediate revisions by 4 users not shown) | |||
| Line 4: | Line 4: | ||
* [[Naming Conventions]] - How to name things like packages, classes, and methods | * [[Naming Conventions]] - How to name things like packages, classes, and methods | ||
* [[Coding Conventions]] - How to make Java code readable | * [[Coding Conventions]] - How to make Java code readable | ||
| + | ** [[Orion/Coding conventions|JavaScript, HTML, and CSS Coding Conventions]] (from the Orion project) | ||
* [[Javadoc]] - How to write documentation comments, especially for API | * [[Javadoc]] - How to write documentation comments, especially for API | ||
* [[User Interface Guidelines]] - How to achieve user interface consistency | * [[User Interface Guidelines]] - How to achieve user interface consistency | ||
| + | * [[Version Numbering]] - How to evolve plug-in version numbers | ||
| + | |||
| + | [[Category:How to Contribute]] | ||
Revision as of 16:22, 21 May 2013
As with any product being built by a team, there are various areas where standards, conventions, and other guidelines can play a role in helping to ensure that the resulting product presents to developers and customers as a unified whole rather than as a loose collection of parts worked on by a variety of individuals each with their own styles and ways of working.
The following list of standards, conventions, and guidelines cover a wide range of aspects of the Eclipse project:
- Naming Conventions - How to name things like packages, classes, and methods
- Coding Conventions - How to make Java code readable
- JavaScript, HTML, and CSS Coding Conventions (from the Orion project)
- Javadoc - How to write documentation comments, especially for API
- User Interface Guidelines - How to achieve user interface consistency
- Version Numbering - How to evolve plug-in version numbers