Add some comments for magic numbers + Add tests

Author: petrochenkov

clippy_lints/src/doc.rs

@@ -264,6 +264,7 @@ pub fn strip_doc_comment_decoration(doc: &str, comment_kind: CommentKind, span:
         let mut doc = doc.to_owned();
         doc.push('\n');
         let len = doc.len();
+        // +3 skips the opening delimiter
         return (doc, vec![(len, span.with_lo(span.lo() + BytePos(3)))]);
     }
 
@@ -273,7 +274,7 @@ pub fn strip_doc_comment_decoration(doc: &str, comment_kind: CommentKind, span:
         let offset = line.as_ptr() as usize - doc.as_ptr() as usize;
         debug_assert_eq!(offset as u32 as usize, offset);
         contains_initial_stars |= line.trim_start().starts_with('*');
-        // +1 for the newline
+        // +1 adds the newline, +3 skips the opening delimiter
         sizes.push((line.len() + 1, span.with_lo(span.lo() + BytePos(3 + offset as u32))));
     }
     if !contains_initial_stars {

clippy_lints/src/tabs_in_doc_comments.rs

@@ -64,6 +64,7 @@ impl TabsInDocComments {
             let comment = comment.as_str();
 
             for (lo, hi) in get_chunks_of_tabs(&comment) {
+                // +3 skips the opening delimiter
                 let new_span = Span::new(
                     attr.span.lo() + BytePos(3 + lo),
                     attr.span.lo() + BytePos(3 + hi),