From db319a8fb0126b84e0a0abbac83d4e1adeca6a95 Mon Sep 17 00:00:00 2001
From: Andy Russell <arussell123@gmail.com>
Date: Wed, 22 Jan 2020 11:24:32 -0500
Subject: [PATCH] suggest adding space in accidental doc comments

---
 src/librustc_parse/parser/stmt.rs             | 21 +++++++-
 src/test/ui/parser/doc-comment-in-stmt.rs     | 20 ++++++++
 src/test/ui/parser/doc-comment-in-stmt.stderr | 50 +++++++++++++++++++
 3 files changed, 89 insertions(+), 2 deletions(-)
 create mode 100644 src/test/ui/parser/doc-comment-in-stmt.rs
 create mode 100644 src/test/ui/parser/doc-comment-in-stmt.stderr

diff --git a/src/librustc_parse/parser/stmt.rs b/src/librustc_parse/parser/stmt.rs
index a94d8228bbe..ae8f1e4db1b 100644
--- a/src/librustc_parse/parser/stmt.rs
+++ b/src/librustc_parse/parser/stmt.rs
@@ -7,13 +7,13 @@ use crate::maybe_whole;
 use crate::DirectoryOwnership;
 
 use rustc_errors::{Applicability, PResult};
-use rustc_span::source_map::{respan, Span};
+use rustc_span::source_map::{respan, BytePos, Span};
 use rustc_span::symbol::{kw, sym, Symbol};
 use syntax::ast;
 use syntax::ast::{AttrStyle, AttrVec, Attribute, Mac, MacStmtStyle, VisibilityKind};
 use syntax::ast::{Block, BlockCheckMode, Expr, ExprKind, Local, Stmt, StmtKind, DUMMY_NODE_ID};
 use syntax::ptr::P;
-use syntax::token;
+use syntax::token::{self, TokenKind};
 use syntax::util::classify;
 
 use std::mem;
@@ -431,6 +431,23 @@ impl<'a> Parser<'a> {
                     if let Err(mut e) =
                         self.expect_one_of(&[], &[token::Semi, token::CloseDelim(token::Brace)])
                     {
+                        if let TokenKind::DocComment(..) = self.token.kind {
+                            if let Ok(snippet) = self.span_to_snippet(self.token.span) {
+                                let sp = self.token.span;
+                                let marker = &snippet[..3];
+                                let (comment_marker, doc_comment_marker) = marker.split_at(2);
+
+                                e.span_suggestion(
+                                    sp.with_hi(sp.lo() + BytePos(marker.len() as u32)),
+                                    &format!(
+                                        "add a space before `{}` to use a regular comment",
+                                        doc_comment_marker,
+                                    ),
+                                    format!("{} {}", comment_marker, doc_comment_marker),
+                                    Applicability::MaybeIncorrect,
+                                );
+                            }
+                        }
                         e.emit();
                         self.recover_stmt();
                         // Don't complain about type errors in body tail after parse error (#57383).
diff --git a/src/test/ui/parser/doc-comment-in-stmt.rs b/src/test/ui/parser/doc-comment-in-stmt.rs
new file mode 100644
index 00000000000..b02df13213f
--- /dev/null
+++ b/src/test/ui/parser/doc-comment-in-stmt.rs
@@ -0,0 +1,20 @@
+fn foo() -> bool {
+    false
+    //!self.allow_ty_infer()
+    //~^ ERROR found doc comment
+}
+
+fn bar() -> bool {
+    false
+    /*! bar */ //~ ERROR found doc comment
+}
+
+fn baz() -> i32 {
+    1 /** baz */ //~ ERROR found doc comment
+}
+
+fn quux() -> i32 {
+    2 /*! quux */ //~ ERROR found doc comment
+}
+
+fn main() {}
diff --git a/src/test/ui/parser/doc-comment-in-stmt.stderr b/src/test/ui/parser/doc-comment-in-stmt.stderr
new file mode 100644
index 00000000000..5d94d6fe69b
--- /dev/null
+++ b/src/test/ui/parser/doc-comment-in-stmt.stderr
@@ -0,0 +1,50 @@
+error: expected one of `.`, `;`, `?`, `}`, or an operator, found doc comment `//!self.allow_ty_infer()`
+  --> $DIR/doc-comment-in-stmt.rs:3:5
+   |
+LL |     false
+   |          - expected one of `.`, `;`, `?`, `}`, or an operator
+LL |     //!self.allow_ty_infer()
+   |     ^^^^^^^^^^^^^^^^^^^^^^^^ unexpected token
+   |
+help: add a space before `!` to use a regular comment
+   |
+LL |     // !self.allow_ty_infer()
+   |     ^^^^
+
+error: expected one of `.`, `;`, `?`, `}`, or an operator, found doc comment `/*! bar */`
+  --> $DIR/doc-comment-in-stmt.rs:9:5
+   |
+LL |     false
+   |          - expected one of `.`, `;`, `?`, `}`, or an operator
+LL |     /*! bar */
+   |     ^^^^^^^^^^ unexpected token
+   |
+help: add a space before `!` to use a regular comment
+   |
+LL |     /* ! bar */
+   |     ^^^^
+
+error: expected one of `.`, `;`, `?`, `}`, or an operator, found doc comment `/** baz */`
+  --> $DIR/doc-comment-in-stmt.rs:13:7
+   |
+LL |     1 /** baz */
+   |       ^^^^^^^^^^ expected one of `.`, `;`, `?`, `}`, or an operator
+   |
+help: add a space before `*` to use a regular comment
+   |
+LL |     1 /* * baz */
+   |       ^^^^
+
+error: expected one of `.`, `;`, `?`, `}`, or an operator, found doc comment `/*! quux */`
+  --> $DIR/doc-comment-in-stmt.rs:17:7
+   |
+LL |     2 /*! quux */
+   |       ^^^^^^^^^^^ expected one of `.`, `;`, `?`, `}`, or an operator
+   |
+help: add a space before `!` to use a regular comment
+   |
+LL |     2 /* ! quux */
+   |       ^^^^
+
+error: aborting due to 4 previous errors
+