Skip to content

Instantly share code, notes, and snippets.

@JoySH
Created August 25, 2017 15:25
Show Gist options
  • Save JoySH/8162f29e6cb34435a450b30a9f4dd12b to your computer and use it in GitHub Desktop.
Save JoySH/8162f29e6cb34435a450b30a9f4dd12b to your computer and use it in GitHub Desktop.
public with sharing class welcome {
//Welcome! I'm a comment and I'm here to tell you what this particular class file is for. The developer who created this class added
//me so that future developers, like yourself, would have a quick little introduction to what this class does.
//The two little slashes tell the compiler* that everything following on this line is a note
//for humans and not code that needs to be executed
// (* A compiler is the computer program that translates this code into executable computer instructions)
//But you know what? This set of comments is already several lines long and getting longer. I'm tired of typing two slashes every time
/*There. That's better. the '/*' tells the compiler that there are multiple lines of comments coming. It knows everthing on this line
and any following lines
and lines
and lines
and lines will continue to be comments
until it sees a */
//Ok, let's get started!
public static void youDoThisPart() {
/*Your assignment is to write two comments below this one. They can say whatever you like.
Make one as a single line comment using the // notation. Make the other one a multi line comment using the /* notation.
When you're done, save this file so that it is compiled and stored in Salesforce. */
// This single line comment makes sense for small snippets
//
/* Is a better choice for longer explanations
that might include reason
A.
B.
C.
D.
or even more! */
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment