Unit 3. Discussing Code
vocabulary - Modifiers
When discussing code, modifiers can be extremely useful for making your feedback constructive and precise.
- modifiers: words that change the meaning of a sentence
For example, a colleague asks:
What do you think of the website?
Response 1: It’s good When I click something it loads very quickly and I can navigate it easyily without any instructions.
Response 2: It’s good! It’s very responsive and can be navigated intuitively.
By using technical adjectives and adverbs, Response 2 sounds more clear and professional. There are some modifiers can be used in your opinion on technical topics:
- scalable
- robust
- consistent
- user-friendly
- reusable
- seamlessly
Examples:
I like the interface of GitHub; it’s very easy to use and understand.
I like the interface of GitHub; it’s very user-friendly.Developers should follow the same coding practices.
Developers should follow consistent coding practices.Can you explain why a strong code review process is important?
Can you explain why a robust code review process is important?New features should be integrated smoothly and without disruptions.
New features should be integrated seamlessly (无缝的).I want you to focus on building components that can be used many times.
I want you to focus on building components that reusable.Our infrastructure needs to be able to be made larger to handle an increase in users.
Our infrastructure needs to be scalable to handle an increase in users.
grammer - Placement of Modifiers
When a modifier isn’t used in correct position, it can make the sentence confusing for a reader/listner.
- Incorrect: “The algorithm solved(verb) quickly the problem(noun).”
- Correct: “The algorithm solved the problem quickly.”
OR: “The algorithm quickly solved the problem.”
Example:
maintainable: It’s important to write code.
It’s important to write maintainable code.briefly: The comment should describe what each function does.
The comment should briefly describle what each function does.accurately: Using a version control system helps to track changes.
Using a version control system helps to accutately track changes.critical: Joe mentioned several issues that need immediate attention.
Joe mentioned several critical issues that are needed immediate attention.constructive: I want to thank the team for providing feedback.
I want to thank the team for providing constructive feedback.versatile (多才多艺的): I spoke with the team and they liked our framework.
I spoke with the team and they liked our versatile framework.