hover: signature description not removing first "#" "@"

Author: xuhuanzy

crates/emmylua_code_analysis/src/compilation/analyzer/doc/field_or_operator_def_tags.rs

@@ -6,6 +6,7 @@ use emmylua_parser::{
 };
 
 use crate::{
+    compilation::analyzer::doc::preprocess_description,
     db_index::{
         LuaMember, LuaMemberKey, LuaMemberOwner, LuaOperator, LuaOperatorMetaMethod,
         LuaSemanticDeclId, LuaType,
@@ -134,7 +135,8 @@ pub fn analyze_field(analyzer: &mut DocAnalyzer, tag: LuaDocTagField) -> Option<
         );
     }
 
-    if let Some(description) = description {
+    if let Some(mut description) = description {
+        description = preprocess_description(&description, Some(&property_owner));
         analyzer.db.get_property_index_mut().add_description(
             analyzer.file_id,
             property_owner.clone(),

crates/emmylua_code_analysis/src/compilation/analyzer/doc/infer_type.rs

@@ -588,7 +588,8 @@ fn infer_multi_line_union_type(
         };
 
         let description = if let Some(description) = field.get_description() {
-            let description_text = preprocess_description(&description.get_description_text());
+            let description_text =
+                preprocess_description(&description.get_description_text(), None);
             if !description_text.is_empty() {
                 Some(description_text)
             } else {

crates/emmylua_code_analysis/src/compilation/analyzer/doc/mod.rs

@@ -11,7 +11,7 @@ use super::AnalyzeContext;
 use crate::{
     db_index::{DbIndex, LuaTypeDeclId},
     profile::Profile,
-    FileId,
+    FileId, LuaSemanticDeclId,
 };
 use emmylua_parser::{LuaAstNode, LuaComment, LuaDocDescriptionOwner, LuaSyntaxNode};
 use file_generic_index::FileGenericIndex;
@@ -44,8 +44,10 @@ fn analyze_comment(analyzer: &mut DocAnalyzer) -> Option<()> {
     }
 
     let owenr = get_owner_id(analyzer)?;
-    let comment_description =
-        preprocess_description(&comment.get_description()?.get_description_text());
+    let comment_description = preprocess_description(
+        &comment.get_description()?.get_description_text(),
+        Some(&owenr),
+    );
     analyzer.db.get_property_index_mut().add_description(
         analyzer.file_id,
         owenr,
@@ -90,9 +92,16 @@ impl<'a> DocAnalyzer<'a> {
     }
 }
 
-pub fn preprocess_description(mut description: &str) -> String {
-    if description.starts_with(['#', '@']) {
-        description = description.trim_start_matches(|c| c == '#' || c == '@');
+pub fn preprocess_description(mut description: &str, owner: Option<&LuaSemanticDeclId>) -> String {
+    let has_remove_start_char = if let Some(owner) = owner {
+        !matches!(owner, LuaSemanticDeclId::Signature(_))
+    } else {
+        true
+    };
+    if has_remove_start_char {
+        if description.starts_with(['#', '@']) {
+            description = description.trim_start_matches(|c| c == '#' || c == '@');
+        }
     }
 
     let mut result = String::new();

crates/emmylua_code_analysis/src/compilation/analyzer/doc/type_def_tags.rs

@@ -94,15 +94,15 @@ fn add_description_for_type_decl(
     if !is_class {
         let comment = analyzer.comment.clone();
         if let Some(description) = comment.get_description() {
-            let description = preprocess_description(&description.get_description_text());
+            let description = preprocess_description(&description.get_description_text(), None);
             if !description.is_empty() {
                 description_text.push_str(&description);
             }
         }
     }
 
     if let Some(description) = description {
-        let description = preprocess_description(&description.get_description_text());
+        let description = preprocess_description(&description.get_description_text(), None);
         if !description.is_empty() {
             if !description_text.is_empty() {
                 description_text.push_str("\n\n");

crates/emmylua_code_analysis/src/compilation/analyzer/doc/type_ref_tags.rs

@@ -116,7 +116,7 @@ pub fn analyze_param(analyzer: &mut DocAnalyzer, tag: LuaDocTagParam) -> Option<
     }
 
     let description = if let Some(des) = tag.get_description() {
-        Some(preprocess_description(&des.get_description_text()))
+        Some(preprocess_description(&des.get_description_text(), None))
     } else {
         None
     };
@@ -155,7 +155,7 @@ pub fn analyze_param(analyzer: &mut DocAnalyzer, tag: LuaDocTagParam) -> Option<
 
 pub fn analyze_return(analyzer: &mut DocAnalyzer, tag: LuaDocTagReturn) -> Option<()> {
     let description = if let Some(des) = tag.get_description() {
-        Some(preprocess_description(&des.get_description_text()))
+        Some(preprocess_description(&des.get_description_text(), None))
     } else {
         None
     };
@@ -383,7 +383,7 @@ pub fn analyze_other(analyzer: &mut DocAnalyzer, other: LuaDocTagOther) -> Optio
     let owner = get_owner_id(analyzer)?;
     let tag_name = other.get_tag_name()?;
     let description = if let Some(des) = other.get_description() {
-        let description = preprocess_description(&des.get_description_text());
+        let description = preprocess_description(&des.get_description_text(), None);
         format!("@*{}* {}", tag_name, description)
     } else {
         format!("@*{}*", tag_name)

crates/emmylua_ls/src/handlers/hover/hover_builder.rs

@@ -284,6 +284,9 @@ impl<'a> HoverBuilder<'a> {
         result.push_str(&description_content);
         result.push_str(&expansion);
 
+        // 清除空白字符
+        result = result.trim().to_string();
+
         Some(Hover {
             contents: HoverContents::Markup(MarkupContent {
                 kind: lsp_types::MarkupKind::Markdown,

crates/emmylua_ls/src/handlers/test/hover_test.rs

@@ -180,4 +180,19 @@ mod tests {
             },
         ));
     }
+
+    #[test]
+    fn test_signature_desc() {
+        let mut ws = ProviderVirtualWorkspace::new();
+        assert!(ws.check_hover(
+            r#"
+            -- # A
+            local function a<??>bc()
+            end
+            "#,
+            VirtualHoverResult {
+                value: "```lua\nlocal function abc()\n```\n\n---\n\n# A".to_string(),
+            },
+        ));
+    }
 }