Skip to content

Conventions of Software development

Renuka Theminda Kirulapana edited this page May 7, 2024 · 4 revisions

a convention refers to a set of agreed-upon guidelines, standards, or practices that developers follow when writing code or organizing project structures.

Here are a few examples of conventions in software development:

Naming Conventions:

Guidelines for naming variables, functions, classes, and other code elements. For example, using camelCase for variable names in JavaScript or following the Java naming conventions for classes and methods in Java.

File and Directory Structure:

Conventions for organizing files and directories within a project. This may include placing source code files in specific directories (e.g., separating source files from test files) or following a certain directory hierarchy for different types of files (e.g., placing configuration files in a config directory).

Code Formatting:

Consistent formatting of code for readability and maintainability. This may include indentation styles, spacing, line length limits, and placement of braces and parentheses. Version Control Practices: Conventions for using version control systems such as Git, including branching strategies, commit message formats, and repository structure.

Documentation Conventions:

Guidelines for documenting code, such as documenting function parameters, return values, and usage examples. This may include using specific documentation formats like Javadoc for Java or Sphinx for Python. Coding Standards: Standards for writing code that promote best practices, reduce bugs, and improve code quality. This may include guidelines for error handling, code reuse, performance optimization, and security practices.

Clone this wiki locally