Missing Document Title
theme: Next, 1
Hopefully our code is understandable only from reading what is there. We often, however, need to describe the process our code is following or require additional details about how our code works.
Just as with using good variable names, clarity of code comments help us. Remember that code is written once but read many times.
For this we can use
comments in our code.
// This is the name of our shipvar shipName = "Heart of Gold";// We need to know how many characters there are in order to center the text on the screen.var characterCount = shipName.Length;/*Build a TurboencabulatorThe original machine had a base plate of pre-famulated amulitesurmounted by a malleable logarithmic casing in such a way thatthe two spurving bearings were in a direct line with the panametricfan. The latter consisted simply of six hydrocoptic marzlevanes, sofitted to the ambifacient lunar waneshaft that side fumbling waseffectively prevented.See: https://www.youtube.com/watch?v=Ac7G7xOG2AgSee: https://en.wikipedia.org/wiki/Turboencabulator*/
Nearly every editor has support for adding and removing comments for both single lines of text as well as blocks.
In Visual Studio Code you can start a comment with the key
Control / (or
Command / on Mac) on any line.
This will start a new comment and you can type your text. If you press enter the cursor will make a new comment line.
You can toggle comments by highlighting the lines and pressing the commenting key combination.
As you write code you'll be tempted to "comment out" code. That is, take one or more lines of code and place them inside a comment.
This is natural and often done during development. We'd like you to adhere by one guideline:
Don't commit commented out code to your git repository
^ The idea here is that commenting out code should be a development-time activity. Never publish/share/commit files that have commented out code.