diff --git a/scripts/README.md b/scripts/README.md index 1e8857dc7..7636f3567 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -1,8 +1,9 @@ Some Scripts ============ -`comments.sh` - use to generate a cpp file with some comments +### comments.sh +`comments.sh` - it's used to generate author and problem description comments 1) Create a file named largestNumber.cpp, and add Copyright & Problem description ``` @@ -14,8 +15,7 @@ Some Scripts ./comments.sh https://oj.leetcode.com/problems/largest-number/ largestNumber.cpp ``` - -the cpp source file's comment will be like blow: +The comments would be generated by above examples as below: ``` // Source : https://oj.leetcode.com/problems/largest-number/