Add comments

Avogar · Avogar · commit 1024bb9df563 · 2024-12-10T19:19:09.000Z
diff --git a/src/Parsers/ExpressionElementParsers.cpp b/src/Parsers/ExpressionElementParsers.cpp
@@ -417,6 +417,7 @@ bool ParserCompoundIdentifier::parseImpl(Pos & pos, ASTPtr & node, Expected & ex
 
 std::optional<std::pair<char, String>> ParserCompoundIdentifier::splitSpecialDelimiterAndIdentifierIfAny(const String & name)
 {
+    /// Identifier with special delimiter looks like this: <special_delimiter>`<identifier>`.
     if (name.size() < 3
         || (name[0] != char(SpecialDelimiter::JSON_PATH_DYNAMIC_TYPE) && name[0] != char(SpecialDelimiter::JSON_PATH_PREFIX))
         || name[1] != '`' || name.back() != '`')
diff --git a/src/Parsers/ExpressionElementParsers.h b/src/Parsers/ExpressionElementParsers.h
@@ -66,6 +66,8 @@ class ParserCompoundIdentifier : public IParserBase
     {
     }
 
+    /// Checks if the identirier is actually a pair of a special delimiter and the identifier in back quotes.
+    /// For example: :`UInt64` or ^`path` from special JSON subcolumns.
     static std::optional<std::pair<char, String>> splitSpecialDelimiterAndIdentifierIfAny(const String & name);
 
 protected:

Original file line number	Diff line number	Diff line change
`@@ -417,6 +417,7 @@ bool ParserCompoundIdentifier::parseImpl(Pos & pos, ASTPtr & node, Expected & ex`
`417`	`417`
`418`	`418`	`std::optional<std::pair<char, String>> ParserCompoundIdentifier::splitSpecialDelimiterAndIdentifierIfAny(const String & name)`
`419`	`419`	`{`
	`420`	+ /// Identifier with special delimiter looks like this: <special_delimiter>`<identifier>`.
`420`	`421`	`if (name.size() < 3`
`421`	`422`	`\|\| (name[0] != char(SpecialDelimiter::JSON_PATH_DYNAMIC_TYPE) && name[0] != char(SpecialDelimiter::JSON_PATH_PREFIX))`
`422`	`423`	\|\| name[1] != '`' \|\| name.back() != '`')
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,8 @@ class ParserCompoundIdentifier : public IParserBase`
`66`	`66`	`{`
`67`	`67`	`}`
`68`	`68`
	`69`	`+ /// Checks if the identirier is actually a pair of a special delimiter and the identifier in back quotes.`
	`70`	+ /// For example: :`UInt64` or ^`path` from special JSON subcolumns.
`69`	`71`	`static std::optional<std::pair<char, String>> splitSpecialDelimiterAndIdentifierIfAny(const String & name);`
`70`	`72`
`71`	`73`	`protected:`