Software Engineering Best-Practice
Jump to navigation
Jump to search
A Software Engineering Best-Practice is a software engineering practice that is an engineering best-practice.
- Context:
- …
- Example(s):
- Counter-Example(s):
- See: Software Engineer, Center of Excellence.
References
2019b
- Brian Hannaway. (2019). “The Importance of Comments for Maintainable Code - Do you use comments?."
- QUOTE: ... as developers we have a responsibility to go beyond implementing functional requirements and write code that’s easy to read, understand and maintain.
- Good Structure — classes with a single responsibility, functions that do one thing.
- Descriptive Naming — classes, functions, and variables should have clear, descriptive names.
- Unit Test Coverage — unit tests describe how a component should behave. As well as testing expected behavior they act as a form of component specification.
- Comments — comments provide important information that can’t easily be expressed by the code. ... write your comments with less experienced developers in mind.
- QUOTE: ... as developers we have a responsibility to go beyond implementing functional requirements and write code that’s easy to read, understand and maintain.
2014
- https://www.cs.utexas.edu/~mitra/csSummer2014/cs312/lectures/bestPractices.html
- QUOTE: ... Best practices are a set of empirically proven approaches to software development. When used in combination they strike at the root causes of software development problems. They are called "best practices" not because we can precisely quantify their value but rather they are observed to be commonly used in industry by successful organizations.
What are the best practices in software engineering?
- QUOTE: ... Best practices are a set of empirically proven approaches to software development. When used in combination they strike at the root causes of software development problems. They are called "best practices" not because we can precisely quantify their value but rather they are observed to be commonly used in industry by successful organizations.