Self-Learning Module

Outcomes Covered

Coding Standards

• Explain the purpose of a coding standard
• Apply the MSOE Coding Standard

Introduction and Motivation [6:55]

• Skim sections 8.1-2 of the textbook but note that the coding conventions in the textbook do not always align with the conventions used in our class.
• Watch the following video [link]

• You should be able to answer question 1 of the Self-Learning Module 5 quiz in Canvas.

The Rules [8:52]

• Study section 8.3 of the textbook
• Study the coding standard page
• Watch the following video [link]

• You should be able to answer questions 2-8 of the Self-Learning Module 5 quiz in Canvas.

Configuring CheckStyle in IntelliJ [6:05]

• Watch the following video [link]
• Configure IntelliJ to use CheckStyle with the MSOE configuration file

• You should be able to answer questions 9-10 of the Self-Learning Module 5 quiz in Canvas.

Bonus Material (optional)

Thoughts on Comments

• I encourage you to that a look at this article on good commenting: Writing System Software: Code Comments

Tip Videos

• Sabrina Stangler on what to do when you're overwhelmed [1:35] [link]

• Dr. Taylor on learning by teaching [1:20] [link]