add comment

wxiaoguang · wxiaoguang · commit 3c2aa66d7f8d · 2022-07-09T20:47:50.000+08:00
diff --git a/services/gitdiff/gitdiff.go b/services/gitdiff/gitdiff.go
@@ -284,6 +284,7 @@ func DiffInlineWithHighlightCode(fileName, language, code string) DiffInline {
 }
 
 // highlightCodeDiff is used to do diff with highlighted HTML code.
+// It totally depends on Chroma's valid HTML output and its structure, do not use these functions for other purposes.
 // The HTML tags will be replaced by Unicode placeholders: "<span>{TEXT}</span>" => "\uE000{TEXT}\uE001"
 // These Unicode placeholders are friendly to the diff.
 // Then after diff, the placeholders in diff result will be recovered to the HTML tags.

Original file line number	Diff line number	Diff line change
`@@ -284,6 +284,7 @@ func DiffInlineWithHighlightCode(fileName, language, code string) DiffInline {`
`284`	`284`	`}`
`285`	`285`
`286`	`286`	`// highlightCodeDiff is used to do diff with highlighted HTML code.`
	`287`	`+// It totally depends on Chroma's valid HTML output and its structure, do not use these functions for other purposes.`
`287`	`288`	`// The HTML tags will be replaced by Unicode placeholders: "<span>{TEXT}</span>" => "\uE000{TEXT}\uE001"`
`288`	`289`	`// These Unicode placeholders are friendly to the diff.`
`289`	`290`	`// Then after diff, the placeholders in diff result will be recovered to the HTML tags.`