chore: better comment hovers preview [ci skip] (#1612)

diff --git a/packages/compiler-core/src/options.ts b/packages/compiler-core/src/options.ts
index c5e9deaf02f3b6c57947fa7f4e2c0388efe897a8..52eb8fa8028030805885090bcc036dbf25d56f35 100644 (file)
--- a/packages/compiler-core/src/options.ts
+++ b/packages/compiler-core/src/options.ts
@@ -10,19 +10,19 @@ import { ParserPlugin } from '@babel/parser'
 
 export interface ParserOptions {
   /**
-   * e.g. platform native elements, e.g. <div> for browsers
+   * e.g. platform native elements, e.g. `<div>` for browsers
    */
   isNativeTag?: (tag: string) => boolean
   /**
-   * e.g. native elements that can self-close, e.g. <img>, <br>, <hr>
+   * e.g. native elements that can self-close, e.g. `<img>`, `<br>`, `<hr>`
    */
   isVoidTag?: (tag: string) => boolean
   /**
-   * e.g. elements that should preserve whitespace inside, e.g. <pre>
+   * e.g. elements that should preserve whitespace inside, e.g. `<pre>`
    */
   isPreTag?: (tag: string) => boolean
   /**
-   * Platform-specific built-in components e.g. <Transition>
+   * Platform-specific built-in components e.g. `<Transition>`
    */
   isBuiltInComponent?: (tag: string) => symbol | void
   /**
@@ -127,7 +127,7 @@ export interface TransformOptions {
    */
   ssr?: boolean
   /**
-   * SFC <style vars> injection string
+   * SFC `<style vars>` injection string
    * needed to render inline CSS variables on component root
    */
   ssrCssVars?: string

diff --git a/packages/compiler-sfc/src/compileScript.ts b/packages/compiler-sfc/src/compileScript.ts
index 80800a8f7d998589b12a1d51ff108cd7b28991e1..84345e79ce8f67cf16e39cc291999b4251e6e663 100644 (file)
--- a/packages/compiler-sfc/src/compileScript.ts
+++ b/packages/compiler-sfc/src/compileScript.ts
@@ -876,7 +876,7 @@ function genRuntimeEmits(emits: Set<string>) {
 }
 
 /**
- * export default {} inside <script setup> cannot access variables declared
+ * export default {} inside `<script setup>` cannot access variables declared
  * inside since it's hoisted. Walk and check to make sure.
  */
 function checkDefaultExport(

diff --git a/packages/runtime-core/src/helpers/renderSlot.ts b/packages/runtime-core/src/helpers/renderSlot.ts
index 8744b4c30530fe24d7436ba253dd3d0281f945b4..fd19b3a95ff004197d1cf72ef50cbde45d1a5240 100644 (file)
--- a/packages/runtime-core/src/helpers/renderSlot.ts
+++ b/packages/runtime-core/src/helpers/renderSlot.ts
@@ -11,7 +11,7 @@ import { PatchFlags, SlotFlags } from '@vue/shared'
 import { warn } from '../warning'
 
 /**
- * Compiler runtime helper for rendering <slot/>
+ * Compiler runtime helper for rendering `<slot/>`
  * @private
  */
 export function renderSlot(

diff --git a/packages/shared/src/slotFlags.ts b/packages/shared/src/slotFlags.ts
index d111b5e6574ac8eeba769b97caa7f111d9b297e1..3095fb1f33b3c18592dbceceda2dfda5083eb293 100644 (file)
--- a/packages/shared/src/slotFlags.ts
+++ b/packages/shared/src/slotFlags.ts
@@ -12,7 +12,7 @@ export const enum SlotFlags {
    */
   DYNAMIC = 2,
   /**
-   * <slot/> being forwarded into a child component. Whether the parent needs
+   * `<slot/>` being forwarded into a child component. Whether the parent needs
    * to update the child is dependent on what kind of slots the parent itself
    * received. This has to be refined at runtime, when the child's vnode
    * is being created (in `normalizeChildren`)