Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update comment_en.md #29

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/comment_en.md
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
Please contribute here.
#Comments
When you are writing code you may be writing a complex algorithm that after a while you may see the code of aliens. When it comes to building a large system, you will not remember what you wrote or why you wrote it, and it is normal not to. Moreover, if someone reads your code line by line and wants to understand the system, it will not be easy to understand. To solve this problem, it is better to write some comments along with the code. The comment is not actually a code, "write something in the code in your own way for the convenience of understanding the code". Single line and multi-line comments are shown below.
```
// Single line comment, starting with two slashes
/ *
multi-line comment
code description 1
code description 2

* /
```