From 697c040a66c32899b649488055c608cd9cebfda4 Mon Sep 17 00:00:00 2001 From: Annebelle Olminkhof Date: Fri, 21 Dec 2018 06:58:03 +0100 Subject: [PATCH] Added comment usage suggestion (#25941) --- guide/english/ruby/ruby-comments/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/guide/english/ruby/ruby-comments/index.md b/guide/english/ruby/ruby-comments/index.md index 16c7fdcbe8..d05c564e0f 100644 --- a/guide/english/ruby/ruby-comments/index.md +++ b/guide/english/ruby/ruby-comments/index.md @@ -45,3 +45,5 @@ When executed, the program above produces the following: ``` Hello World! ``` + +In general, it's best to use multi-line comments when explaining what your method does or for your program as a whole. Stick to single-line comments when clarifying a line or two of code, but when you find yourself expanding a file just to finish your single-line comment, consider using a multi-line comment instead.