JR2176660

Table of Contents

Markdown Style Guide for Coding Notebooks

Follow this guide to keep your coding notebook clear, consistent, and professional.

This ensures your notes are easy for you (and others) to read later.

Headings

When to use: Organize your notebook into sections (like days, topics, or projects).

Example:

My Coding Notebook

Day 1

Notes

EBAY Built on Java to manage high traffic and complex transactions.
android apps Most Android applications are developed using Java, including popular apps like: WhatsApp, Spotify, Twitter.
LinkedIn Uses Java for its backend services.
Minecraft The original version of this popular game was developed in Java
Personally Identifiable Information Information that can identify you as an individual is called personally identifiable information (PII). It includes details that could reveal who you are—such as your Social Security number, age, race, phone number(s), medical information, financial information, or biometric data like a thumbprint or face scan.
print Make sure the capitalization, parentheses, quotation marks, and semicolon are all in the right place! Don't add any spaces in the whole statement. System accesses a Java class that's built into the language out is short for "output". println is short for "print line".
comments Inline Comments: Short comments placed on the same line as the code to explain it. Multi-line comments: Longer comments placed between code segments. Explaining Code Logic: Help readers understand the use behind certain algorithms or logic. Marking TODOs: Indicate areas of the code that need further work or fixing.
variables In Java, we store information in little containers we call variables. A variable is like a box that can hold a variety of things. In Java, they can hold different types of data. For example, it might hold a number or a word.
string variable Let's create our first variable. When creating a variable, you have to say what kind of data type you are going to put inside it. We will learn more about different data types in an upcoming lesson. For now, we will put a word inside our variable. Data types that are words or phrases are called strings. Let's create a variable named weather that will hold a string data type. String weather = "sunny"; Now that you created a variable, you can just print the variable name and it will print out what the variable holds.

Practice

Text Formatting

When to use: Highlight important ideas or add emphasis.

Use bold for key terms or definitions.

Use italic for emphasis or side comments.

Use inline code for keywords, functions, or commands.

Example:

Class = a blueprint for objects

Remember: always test your code

Use System.out.println() to print

Code Blocks

When to use: Anytime you write multiple lines of code.

Inline code for short snippets.

Fenced code blocks with language for full examples.

Example:


public class Hello {

    public static void main(String[] args) {

        System.out.println("Hello World!");

    }

}

Lists

When to use: Organize steps, notes, or key points.

Numbered lists for sequences or steps.

Bulleted lists for unordered ideas.

Example:

Define the class Write the main method Test your program Variables

Checklists

When to use: Track progress on assignments or tasks.

Example:

[x] Complete coding warm-up

Blockquotes

When to use: Call out notes, reminders, or teacher comments.

Example:

💡 Remember: Loops repeat code until a condition is false.

Tables

When to use: Compare values, track progress, or organize data neatly.

Example:

Task Status Notes

|————–|————|—————–|

Homework 1 Done # Submitted
Homework 2 Pending Needs review

Links & Images

When to use: Add references, resources, or visuals.

Example:

Java Docs

Markdown Logo

To make an image that is a link, paste the image, then add the following before it, replacing website address with the link:

And after the image info, add: </a>

Collapsible Sections

When to use: Hide solutions, extended notes, or extra details.

Example:

Click to reveal solution System.out.println("Answer: 42");

Footnotes

When to use: Add references or side notes without cluttering the page.

Example:

This concept is related to object-oriented programming.1

Style Rules

Consistency matters more than creativity

Always use headings to structure your notes.

Always use code blocks for multi-line code.

Clarity first

Bold key terms.

Use lists instead of long sentences when outlining steps.

Professional tone

Don’t mix casual notes with formal work in the same section.

Use blockquotes for reflections or teacher feedback.

Track your learning

Use checklists to mark what’s done.

Use collapsible sections if you want to hide answers until review time.

Bottom Line:

Headings = Structure

Bold/Italic = Emphasis

Code blocks = Code

Lists = Steps/Ideas

Tables = Organization

Checklists = Progress

Blockquotes = Notes/Tips

Collapsible = Hide/Show detail

Keep it simple, consistent, and clear.

  1. See “Objects and Classes” in your textbook. ↩