From 7e9eb880f67b647ae71fbaaad1887507583aa664 Mon Sep 17 00:00:00 2001 From: dujue55 <37645985+dujue55@users.noreply.github.com> Date: Sun, 3 Nov 2024 10:55:25 +0100 Subject: [PATCH 1/6] Create article.md --- .../article.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 2024/Comments are a programmer's love letters/article.md diff --git a/2024/Comments are a programmer's love letters/article.md b/2024/Comments are a programmer's love letters/article.md new file mode 100644 index 00000000..cf074ba7 --- /dev/null +++ b/2024/Comments are a programmer's love letters/article.md @@ -0,0 +1,17 @@ +# Comments are a programmer's love letters + In the secret language of code, programmers leave little notes called comments. These aren’t for the computers—they couldn’t care less—but for other humans who might peek at the code later, including the programmer themselves who may have forgotten everything overnight. Comments are like scribbles in a textbook, adding hints to make tricky concepts easier to understand. + +For example, a programmer might write: + +``` python +# This is a single-line comment in Python +print("Hello, world!") +``` + +Without comments, code can be a confusing maze. Sure, it works, but why? Comments give clues, like a hidden diary entry: “Here’s why I did this,” or “Don’t touch this—it’s holding everything together!” They’re the programmer’s way of saying, “I was here, and I wanted you to understand.” + +So next time you see a comment, think of it as a love letter—left with care, a dash of humor, and a desire to make things a little clearer, just for you. + +## Author + +Jue Du From 53f207df4d36ae57003e197190e2b4bf6357649f Mon Sep 17 00:00:00 2001 From: dujue55 <37645985+dujue55@users.noreply.github.com> Date: Sun, 3 Nov 2024 11:03:59 +0100 Subject: [PATCH 2/6] Add files via upload --- .../illustration.svg | 1268 +++++++++++++++++ 1 file changed, 1268 insertions(+) create mode 100644 2024/Comments are a programmer's love letters/illustration.svg diff --git a/2024/Comments are a programmer's love letters/illustration.svg b/2024/Comments are a programmer's love letters/illustration.svg new file mode 100644 index 00000000..6de23d44 --- /dev/null +++ b/2024/Comments are a programmer's love letters/illustration.svg @@ -0,0 +1,1268 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From bfb538bb324322c20cb5c1644069eaec909c80b7 Mon Sep 17 00:00:00 2001 From: dujue55 <37645985+dujue55@users.noreply.github.com> Date: Sun, 3 Nov 2024 11:17:59 +0100 Subject: [PATCH 3/6] Update article.md From 08b5ba9bcfc95aee1587f47a461aff0f7ce70e32 Mon Sep 17 00:00:00 2001 From: dujue55 <37645985+dujue55@users.noreply.github.com> Date: Fri, 22 Nov 2024 23:53:20 +0100 Subject: [PATCH 4/6] Update article.md --- .../article.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/2024/Comments are a programmer's love letters/article.md b/2024/Comments are a programmer's love letters/article.md index cf074ba7..4c354f5e 100644 --- a/2024/Comments are a programmer's love letters/article.md +++ b/2024/Comments are a programmer's love letters/article.md @@ -1,16 +1,9 @@ # Comments are a programmer's love letters - In the secret language of code, programmers leave little notes called comments. These aren’t for the computers—they couldn’t care less—but for other humans who might peek at the code later, including the programmer themselves who may have forgotten everything overnight. Comments are like scribbles in a textbook, adding hints to make tricky concepts easier to understand. +In the language of code, programmers leave little notes called comments—not for computers, but for humans who might read the code later. Comments are like textbook scribbles, offering hints to clarify tricky concepts. -For example, a programmer might write: +Without comments, code may be a confusing maze. Sure, it works, but why? Comments give clues, like a hidden diary entry: “Here’s why I did this,” or “Don’t touch this—it’s holding everything together!” Still, balance is important: excessive commenting can clutter the code and reduce its readability, so add comments only where necessary. -``` python -# This is a single-line comment in Python -print("Hello, world!") -``` - -Without comments, code can be a confusing maze. Sure, it works, but why? Comments give clues, like a hidden diary entry: “Here’s why I did this,” or “Don’t touch this—it’s holding everything together!” They’re the programmer’s way of saying, “I was here, and I wanted you to understand.” - -So next time you see a comment, think of it as a love letter—left with care, a dash of humor, and a desire to make things a little clearer, just for you. +Next time you see a comment, think of it as a love letter—left with care, thought, and clarity, just for you. ## Author From 2773faa9b36159385068672d2d623181aafe7f34 Mon Sep 17 00:00:00 2001 From: dujue55 <37645985+dujue55@users.noreply.github.com> Date: Sat, 23 Nov 2024 00:01:50 +0100 Subject: [PATCH 5/6] Update article.md --- 2024/Comments are a programmer's love letters/article.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/2024/Comments are a programmer's love letters/article.md b/2024/Comments are a programmer's love letters/article.md index 4c354f5e..7fb8ae9c 100644 --- a/2024/Comments are a programmer's love letters/article.md +++ b/2024/Comments are a programmer's love letters/article.md @@ -3,7 +3,7 @@ In the language of code, programmers leave little notes called comments—not fo Without comments, code may be a confusing maze. Sure, it works, but why? Comments give clues, like a hidden diary entry: “Here’s why I did this,” or “Don’t touch this—it’s holding everything together!” Still, balance is important: excessive commenting can clutter the code and reduce its readability, so add comments only where necessary. -Next time you see a comment, think of it as a love letter—left with care, thought, and clarity, just for you. +So next time you see a comment, think of it as a love letter—left with care, thought, and clarity, just for you. ## Author From 25ac4740ce2ae327f462ff0b834d306745c191f9 Mon Sep 17 00:00:00 2001 From: dujue55 <37645985+dujue55@users.noreply.github.com> Date: Mon, 16 Dec 2024 22:43:47 +0100 Subject: [PATCH 6/6] Update article.md --- 2024/Comments are a programmer's love letters/article.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/2024/Comments are a programmer's love letters/article.md b/2024/Comments are a programmer's love letters/article.md index 7fb8ae9c..588bc1fb 100644 --- a/2024/Comments are a programmer's love letters/article.md +++ b/2024/Comments are a programmer's love letters/article.md @@ -1,7 +1,7 @@ # Comments are a programmer's love letters In the language of code, programmers leave little notes called comments—not for computers, but for humans who might read the code later. Comments are like textbook scribbles, offering hints to clarify tricky concepts. -Without comments, code may be a confusing maze. Sure, it works, but why? Comments give clues, like a hidden diary entry: “Here’s why I did this,” or “Don’t touch this—it’s holding everything together!” Still, balance is important: excessive commenting can clutter the code and reduce its readability, so add comments only where necessary. +Without comments, code may be a confusing maze. Sure, it works, but why? Comments give clues: “Here’s why I did this,” or “Don’t touch this—it’s holding everything together!” Still, balance is important: excessive commenting can clutter the code and reduce its readability, so add comments only where necessary. So next time you see a comment, think of it as a love letter—left with care, thought, and clarity, just for you.