修正 'contentToString` 注释不严谨处 (#2374)

* 修正 'contentToString` 注释不严谨处 * link `At`
mamoe · Dec 3, 2022 · 5a645b4 · 5a645b4
1 parent e65f4e6
commit 5a645b4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/mirai-core-api/src/commonMain/kotlin/message/data/Message.kt b/mirai-core-api/src/commonMain/kotlin/message/data/Message.kt
@@ -153,7 +153,9 @@ public interface Message {
     public override fun toString(): String
 
     /**
-     * 转为最接近官方格式的字符串, 即 "内容". 如 `At(member) + "test"` 将转为 `"@群名片 test"`.
+     * 转为接近官方格式的字符串, 即 "内容". 如 `At(member) + "test"` 将转为 `"@QQ test"`.
+     *
+     * (对于 [At]，应使用 [At.getDisplay] 将其转为最接近官方格式的字符串 `"@群名片"`)
      *
      * 在使用消息相关 DSL 和扩展时, 一些内容比较的实现均使用 [contentToString] 而不是 [toString].
      *