Code Editor: Fix regression with using doc comments for code regions

[dalexeev]

• Add code region folding to CodeEdit #74843 implemented support for code regions like:

#region New Code Region
<code>
#endregion

• However, after merge Highlight doc comments in a different color #72751 this changed to:

##region New Code Region
<code>
##endregion

This is bad because ## is used for doc comments.

The reason of the regression is that the code editor selects the first comment delimiter, and the delimiter are sorted internally in descending order of delimiter length. I'm guessing the sorting was implemented incorrectly and was originally intended to be in ascending length order.

Addition order: ", ', """, ''', #, ##

Storage order (before): ''', """, ##, #, ', "

Sorting

"
', "
""", ', "
''', """, ', "
''', """, #, ', "
''', """, ##, #, ', "

Storage order (after): ", ', #, ##, """, '''

Sorting

"
", '
", ', """
", ', """, '''
", ', #, """, '''
", ', #, ##, """, '''

After changing the sorting, the regression is fixed, the shortest comment delimiter is selected for the region, I see a lot of sense in this. I didn't notice any other regressions due to this change.

I also fixed the sorting in a similar highlighter code (originally copied from the code editor).

[dalexeev]

I thought about it and now I'm not sure if the order was originally intended to be in ascending length order. If one delimeter is a prefix of another, then it makes sense to check the longer delimeter first to support both. In this case, a better fix would be to invert the loop direction here:

godot/scene/gui/code_edit.cpp

Lines 2856 to 2875 in b137180

	/* Code Region */
	void CodeEdit::_update_code_region_tags() {
	code_region_start_string = "";
	code_region_end_string = "";
	if (code_region_start_tag.is_empty() || code_region_end_tag.is_empty()) {
	return;
	}
	for (int i = 0; i < delimiters.size(); i++) {
	if (delimiters[i].type != DelimiterType::TYPE_COMMENT) {
	continue;
	}
	if (delimiters[i].end_key.is_empty() && delimiters[i].line_only == true) {
	code_region_start_string = delimiters[i].start_key + code_region_start_tag;
	code_region_end_string = delimiters[i].start_key + code_region_end_tag;
	return;
	}
	}
	}

[Paulb23]

Yeah the longer delimiter should take priority in the highlighter. As #74843 is searching for the first comment it probably finds ## first after #72751, so reversing the region comment delimiter search makes sense to me.

[akien-mga]

Thanks!