CDATA Block is not formatter correctly in VS

[YuryKomar]

The function descriprion includes a comment CDATA block is not completely formatted in Visual Studio. I mean the XREF hyperlink, it stil visible in popup...

Will it be fixed?

see attached image

[JRahnama]

We will check this with VS team and will get back to you.

[arunchndr]

Moved to the right repo via dotnet/roslyn#68134. Feel free to close this one.

[JRahnama]

Thank you @arkalyanms. @YuryKomar you can follow this on roslyn repo. Closing this as an external issue.

[sharwell]

The rendering of this comment is an accurate reflection of the content provided here:

SqlClient/doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml

Lines 7 to 47 in f478be5

	<remarks>
	<format type="text/markdown"><![CDATA[
	## Remarks
	When an instance of <xref:Microsoft.Data.SqlClient.SqlCommand> is created, the read/write properties are set to their initial values. For a list of these values, see the <xref:Microsoft.Data.SqlClient.SqlCommand> constructor.
	<xref:Microsoft.Data.SqlClient.SqlCommand> features the following methods for executing commands at a SQL Server database:
	|Item|Description|
	|----------|-----------------|
	|<xref:Microsoft.Data.SqlClient.SqlCommand.BeginExecuteNonQuery%2A>|Initiates the asynchronous execution of the Transact-SQL statement or stored procedure that is described by this <xref:Microsoft.Data.SqlClient.SqlCommand>, generally executing commands such as INSERT, DELETE, UPDATE, and SET statements. Each call to <xref:Microsoft.Data.SqlClient.SqlCommand.BeginExecuteNonQuery%2A> must be paired with a call to <xref:Microsoft.Data.SqlClient.SqlCommand.EndExecuteNonQuery%2A> which finishes the operation, typically on a separate thread.|
	|<xref:Microsoft.Data.SqlClient.SqlCommand.BeginExecuteReader%2A>|Initiates the asynchronous execution of the Transact-SQL statement or stored procedure that is described by this <xref:Microsoft.Data.SqlClient.SqlCommand> and retrieves one or more results sets from the server. Each call to <xref:Microsoft.Data.SqlClient.SqlCommand.BeginExecuteReader%2A> must be paired with a call to <xref:Microsoft.Data.SqlClient.SqlCommand.EndExecuteReader%2A> which finishes the operation, typically on a separate thread.|
	|<xref:Microsoft.Data.SqlClient.SqlCommand.BeginExecuteXmlReader%2A>|Initiates the asynchronous execution of the Transact-SQL statement or stored procedure that is described by this <xref:Microsoft.Data.SqlClient.SqlCommand>. Each call to `BeginExecuteXmlReader` must be paired with a call to `EndExecuteXmlReader`, which finishes the operation, typically on a separate thread, and returns an <xref:System.Xml.XmlReader> object.|
	|<xref:Microsoft.Data.SqlClient.SqlCommand.ExecuteReader%2A>|Executes commands that return rows. For increased performance, <xref:Microsoft.Data.SqlClient.SqlCommand.ExecuteReader%2A> invokes commands using the Transact-SQL `sp_executesql` system stored procedure. Therefore, <xref:Microsoft.Data.SqlClient.SqlCommand.ExecuteReader%2A> might not have the effect that you want if used to execute commands such as Transact-SQL SET statements.|
	|<xref:Microsoft.Data.SqlClient.SqlCommand.ExecuteNonQuery%2A>|Executes commands such as Transact-SQL INSERT, DELETE, UPDATE, and SET statements.|
	|<xref:Microsoft.Data.SqlClient.SqlCommand.ExecuteScalar%2A>|Retrieves a single value (for example, an aggregate value) from a database.|
	|<xref:Microsoft.Data.SqlClient.SqlCommand.ExecuteXmlReader%2A>|Sends the <xref:Microsoft.Data.SqlClient.SqlCommand.CommandText%2A> to the <xref:Microsoft.Data.SqlClient.SqlCommand.Connection%2A> and builds an <xref:System.Xml.XmlReader> object.|
	You can reset the <xref:Microsoft.Data.SqlClient.SqlCommand.CommandText%2A> property and reuse the <xref:Microsoft.Data.SqlClient.SqlCommand> object. However, you must close the <xref:Microsoft.Data.SqlClient.SqlDataReader> before you can execute a new or previous command.
	If a <xref:Microsoft.Data.SqlClient.SqlException> is generated by the method executing a <xref:Microsoft.Data.SqlClient.SqlCommand>, the <xref:Microsoft.Data.SqlClient.SqlConnection> remains open when the severity level is 19 or less. When the severity level is 20 or greater, the server ordinarily closes the <xref:Microsoft.Data.SqlClient.SqlConnection>. However, the user can reopen the connection and continue.
	> [!NOTE]
	> Nameless, also called ordinal, parameters are not supported by the .NET Framework Data Provider for SQL Server.
	## Examples
	The following example creates a <xref:Microsoft.Data.SqlClient.SqlConnection>, a <xref:Microsoft.Data.SqlClient.SqlCommand>, and a <xref:Microsoft.Data.SqlClient.SqlDataReader>. The example reads through the data, writing it to the console. Finally, the example closes the <xref:Microsoft.Data.SqlClient.SqlDataReader> and then the <xref:Microsoft.Data.SqlClient.SqlConnection> as it exits the `Using` code blocks.
	[!code-csharp[SqlCommand Example#1](~/../sqlclient/doc/samples/SqlCommand.cs#1)]
	The following sample shows how to create and execute different types of SqlCommand objects.
	First you must create the sample database, by executing the following script:
	[!code-sql[Setup Database](~/../sqlclient/doc/samples/SqlCommand_Setup.sql#1)]
	Next, compile and execute the following:
	[!code-csharp[SqlCommand Example#2](~/../sqlclient/doc/samples/SqlCommand_Intro.cs#1)]
	]]></format>
	</remarks>

Note that <format type="text/markdown"> is not a recognized content for documentation comments, so the contents of this element will be rendered the same way as if the content was written inline (i.e. not surrounded by the <format> element).

There are no immediate plans to change the language behavior here, but there is an issue filed with a very broad feature request for it: dotnet/csharplang#2394

Some of the changes required include the following. Other changes may be needed as well.

• Removing the <format type="text/markdown"> element
• Wrapping each paragraph in <para>[content]</para>
• Converting all <xref> elements to <see cref="[target]"/>
• Converting the table to <list type="table">

[JRahnama]

This is to inform you that work is currently in progress to resolve the issue. The first PR has been merged, and the remaining updates will follow shortly.

[benrr101]

At long last, the batches have been completed, and the docs have been restructured into XML format. There are a couple follow up tasks, but the bulk of the work is complete.

[benrr101]

(also I guess I messed up by linking the issue to the PR and it auto-closed it...)

[JRahnama]

(also I guess I messed up by linking the issue to the PR and it auto-closed it...)

I think this is fine/correct., as the issue is addressed/being addressed in several PRs.