Make the hover prompts in vs and vscode consistent

packages/compiler/src/server/type-details.ts

@@ -43,10 +43,19 @@ export function getSymbolDetails(
         ) {
           continue;
         }
-        lines.push(
-          //prettier-ignore
-          `_@${tag.tagName.sv}_${"paramName" in tag ? ` \`${tag.paramName.sv}\`` : ""} —\n${getDocContent(tag.content)}`,
-        );
+
+        const descMsg = getDocContent(tag.content);
+        if (descMsg.startsWith("```")) {
+          lines.push(
+            //prettier-ignore
+            fence(`@${tag.tagName.sv}${"paramName" in tag ? `${tag.paramName.sv}` : ""} —`)+`\n${descMsg}`,
+          );
+        } else {
+          lines.push(
+            //prettier-ignore
+            fence(`@${tag.tagName.sv}${"paramName" in tag ? ` ${tag.paramName.sv}` : ""} — ${descMsg}`),
+          );
+        }
       }
     }
   }
@@ -59,7 +68,7 @@ function getSymbolDocumentation(program: Program, symbol: Sym) {
   for (const node of [...symbol.declarations, ...(symbol.node ? [symbol.node] : [])]) {
     // Add /** ... */ developer docs
     for (const d of node.docs ?? []) {
-      docs.push(getDocContent(d.content));
+      docs.push(fence(getDocContent(d.content)));
     }
   }
 
@@ -75,7 +84,7 @@ function getSymbolDocumentation(program: Program, symbol: Sym) {
     const apiDocs = getDocData(program, type);
     // The doc comment is already included above we don't want to duplicate. Only include if it was specificed via `@doc`
     if (apiDocs && apiDocs.source === "decorator") {
-      docs.push(apiDocs.value);
+      docs.push(fence(apiDocs.value));
     }
   }
 
@@ -121,3 +130,7 @@ function getDocContent(content: readonly DocContent[]) {
   }
   return docs.join("");
 }
+
+function fence(content: string) {
+  return content.startsWith("```") ? content : `\`\`\`\n${content}\n\`\`\``;
+}

packages/compiler/test/server/get-hover.test.ts

@@ -50,7 +50,8 @@ describe("compiler: server: on hover", () => {
       deepStrictEqual(hover, {
         contents: {
           kind: MarkupKind.Markdown,
-          value: "(model property)\n```typespec\nMyModel.name: string\n```\n\nname of the model",
+          value:
+            "(model property)\n```typespec\nMyModel.name: string\n```\n\n```\nname of the model\n```",
         },
       });
     });
@@ -152,7 +153,7 @@ describe("compiler: server: on hover", () => {
             "```typespec\n" +
             "dec single(context: unknown)\n" +
             "```\n\n" +
-            "description of single decorator",
+            "```\ndescription of single decorator\n```",
         },
       });
     });
@@ -221,7 +222,7 @@ describe("compiler: server: on hover", () => {
             "MyLogArg.msg: string\n" +
             "```\n" +
             "\n" +
-            "my log message",
+            "```\nmy log message\n```",
         },
       });
     });
@@ -253,7 +254,7 @@ describe("compiler: server: on hover", () => {
             "MyLogContext<T>.item: Record<Element>\n" +
             "```\n" +
             "\n" +
-            "items of context",
+            "```\nitems of context\n```",
         },
       });
     });
@@ -615,7 +616,8 @@ describe("compiler: server: on hover", () => {
       deepStrictEqual(hover, {
         contents: {
           kind: MarkupKind.Markdown,
-          value: "(model property)\n```typespec\nMyModel.name: string\n```\n\nname of the model",
+          value:
+            "(model property)\n```typespec\nMyModel.name: string\n```\n\n```\nname of the model\n```",
         },
       });
     });