refactor(kotlin): update living documentation provider comment style

unit-mesh · Nov 11, 2024 · 25cb1c1 · 25cb1c1
1 parent bcc0651
commit 25cb1c1
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/intentions/action/task/LivingDocPromptBuilder.kt b/core/src/main/kotlin/cc/unitmesh/devti/intentions/action/task/LivingDocPromptBuilder.kt
@@ -135,9 +135,11 @@ open class LivingDocPromptBuilder(
             instruction.append("```${target.language.displayName}\n${target.text}\n```")
 
             val startEndString = documentation.startEndString(type)
-            instruction.append(documentation.forbiddenRules.joinToString { "\n- $it" })
+            if (startEndString != null) {
+                instruction.append("\n\nStart your documentation with ${startEndString.first} here, and ends with `${startEndString.second}`.\n")
+            }
 
-            instruction.append("\n\nStart your documentation with ${startEndString.first} here, and ends with `${startEndString.second}`.\n")
+            instruction.append(documentation.forbiddenRules.joinToString { "\n- $it" })
             instruction.toString()
         }
     }

diff --git a/core/src/main/kotlin/cc/unitmesh/devti/provider/LivingDocumentation.kt b/core/src/main/kotlin/cc/unitmesh/devti/provider/LivingDocumentation.kt
@@ -20,7 +20,7 @@ interface LivingDocumentation {
     val parameterTagInstruction: String? get() = null
     val returnTagInstruction: String? get() = null
 
-    fun startEndString(type: LivingDocumentationType): Pair<String, String>
+    fun startEndString(type: LivingDocumentationType): Pair<String, String>?
 
     fun updateDoc(target: PsiElement, newDoc: String, type: LivingDocumentationType, editor: Editor)
 

diff --git a/goland/src/main/kotlin/cc/unitmesh/go/provider/GoLivingDocumentationProvider.kt b/goland/src/main/kotlin/cc/unitmesh/go/provider/GoLivingDocumentationProvider.kt
@@ -19,7 +19,7 @@ class GoLivingDocumentationProvider : LivingDocumentation {
             "Do not mention the containing package",
         )
 
-    override fun startEndString(type: LivingDocumentationType): Pair<String, String> = "/*" to "*/"
+    override fun startEndString(type: LivingDocumentationType): Pair<String, String>? = null
 
     override fun updateDoc(target: PsiElement, newDoc: String, type: LivingDocumentationType, editor: Editor) {
         val project = runReadAction { target.project }