Use <see langword="..."/> for language keywords.

Author: drieseng

.editorconfig

@@ -488,6 +488,12 @@ dotnet_diagnostic.CA1510.severity = none
 # Since we do not enable any of the Sonar rules by default, we'll leave CA1725 enabled.
 dotnet_diagnostic.CA1725.severity = error
 
+# CA1825: Avoid zero-length array allocations
+# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1825
+#
+# This is a duplicate of MA0005.
+dotnet_diagnostic.CA1825.severity = none
+
 # CA1819: Properties should not return arrays
 #
 # Arrays offer better performance than collections.

src/Renci.SshNet/Abstractions/CryptoAbstraction.cs

@@ -23,7 +23,7 @@ public static byte[] GenerateRandom(int length)
         /// Fills an array of bytes with a cryptographically strong random sequence of values.
         /// </summary>
         /// <param name="data">The array to fill with cryptographically strong random bytes.</param>
-        /// <exception cref="ArgumentNullException"><paramref name="data"/> is <c>null</c>.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
         /// <remarks>
         /// The length of the byte array determines how many random bytes are produced.
         /// </remarks>

src/Renci.SshNet/Abstractions/DnsAbstraction.cs

@@ -30,7 +30,7 @@ internal static class DnsAbstraction
         /// An array of type <see cref="IPAddress"/> that holds the IP addresses for the host that
         /// is specified by the <paramref name="hostNameOrAddress"/> parameter.
         /// </returns>
-        /// <exception cref="ArgumentNullException"><paramref name="hostNameOrAddress"/> is <c>null</c>.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="hostNameOrAddress"/> is <see langword="null"/>.</exception>
         /// <exception cref="SocketException">An error is encountered when resolving <paramref name="hostNameOrAddress"/>.</exception>
         public static IPAddress[] GetHostAddresses(string hostNameOrAddress)
         {
@@ -97,7 +97,7 @@ public static IPAddress[] GetHostAddresses(string hostNameOrAddress)
         /// A task with result of an array of type <see cref="IPAddress"/> that holds the IP addresses for the host that
         /// is specified by the <paramref name="hostNameOrAddress"/> parameter.
         /// </returns>
-        /// <exception cref="ArgumentNullException"><paramref name="hostNameOrAddress"/> is <c>null</c>.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="hostNameOrAddress"/> is <see langword="null"/>.</exception>
         /// <exception cref="SocketException">An error is encountered when resolving <paramref name="hostNameOrAddress"/>.</exception>
         public static Task<IPAddress[]> GetHostAddressesAsync(string hostNameOrAddress)
         {

src/Renci.SshNet/Abstractions/SocketAbstraction.cs

@@ -28,7 +28,7 @@ public static bool CanRead(Socket socket)
         /// </summary>
         /// <param name="socket">The <see cref="Socket"/> to check.</param>
         /// <returns>
-        /// <c>true</c> if <paramref name="socket"/> can be written to; otherwise, <c>false</c>.
+        /// <see langword="true"/> if <paramref name="socket"/> can be written to; otherwise, <see langword="false"/>.
         /// </returns>
         public static bool CanWrite(Socket socket)
         {

src/Renci.SshNet/AuthenticationMethod.cs

@@ -29,7 +29,7 @@ public abstract class AuthenticationMethod : IAuthenticationMethod
         /// Initializes a new instance of the <see cref="AuthenticationMethod"/> class.
         /// </summary>
         /// <param name="username">The username.</param>
-        /// <exception cref="ArgumentException"><paramref name="username"/> is whitespace or <c>null</c>.</exception>
+        /// <exception cref="ArgumentException"><paramref name="username"/> is whitespace or <see langword="null"/>.</exception>
         protected AuthenticationMethod(string username)
         {
             if (string.IsNullOrWhiteSpace(username))

src/Renci.SshNet/BaseClient.cs

@@ -69,7 +69,7 @@ private set
         /// Gets a value indicating whether this client is connected to the server.
         /// </summary>
         /// <value>
-        /// <c>true</c> if this client is connected; otherwise, <c>false</c>.
+        /// <see langword="true"/> if this client is connected; otherwise, <see langword="false"/>.
         /// </value>
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
         public bool IsConnected
@@ -158,9 +158,9 @@ public TimeSpan KeepAliveInterval
         /// </summary>
         /// <param name="connectionInfo">The connection info.</param>
         /// <param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
-        /// <exception cref="ArgumentNullException"><paramref name="connectionInfo"/> is <c>null</c>.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
         /// <remarks>
-        /// If <paramref name="ownsConnectionInfo"/> is <c>true</c>, then the
+        /// If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, then the
         /// connection info will be disposed when this instance is disposed.
         /// </remarks>
         protected BaseClient(ConnectionInfo connectionInfo, bool ownsConnectionInfo)
@@ -174,10 +174,10 @@ protected BaseClient(ConnectionInfo connectionInfo, bool ownsConnectionInfo)
         /// <param name="connectionInfo">The connection info.</param>
         /// <param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
         /// <param name="serviceFactory">The factory to use for creating new services.</param>
-        /// <exception cref="ArgumentNullException"><paramref name="connectionInfo"/> is <c>null</c>.</exception>
-        /// <exception cref="ArgumentNullException"><paramref name="serviceFactory"/> is <c>null</c>.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="serviceFactory"/> is <see langword="null"/>.</exception>
         /// <remarks>
-        /// If <paramref name="ownsConnectionInfo"/> is <c>true</c>, then the
+        /// If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, then the
         /// connection info will be disposed when this instance is disposed.
         /// </remarks>
         private protected BaseClient(ConnectionInfo connectionInfo, bool ownsConnectionInfo, IServiceFactory serviceFactory)
@@ -402,7 +402,7 @@ public void Dispose()
         /// <summary>
         /// Releases unmanaged and - optionally - managed resources.
         /// </summary>
-        /// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
+        /// <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
         protected virtual void Dispose(bool disposing)
         {
             if (_isDisposed)
@@ -566,7 +566,7 @@ private void DisposeSession(ISession session)
         }
 
         /// <summary>
-        /// Disposes the SSH session, and assigns <c>null</c> to <see cref="Session"/>.
+        /// Disposes the SSH session, and assigns <see langword="null"/> to <see cref="Session"/>.
         /// </summary>
         private void DisposeSession()
         {
@@ -582,7 +582,7 @@ private void DisposeSession()
         /// Returns a value indicating whether the SSH session is established.
         /// </summary>
         /// <returns>
-        /// <c>true</c> if the SSH session is established; otherwise, <c>false</c>.
+        /// <see langword="true"/> if the SSH session is established; otherwise, <see langword="false"/>.
         /// </returns>
         private bool IsSessionConnected()
         {

src/Renci.SshNet/Channels/Channel.cs

@@ -29,8 +29,8 @@ internal abstract class Channel : IChannel
         /// Holds a value indicating whether the SSH_MSG_CHANNEL_CLOSE has been sent to the remote party.
         /// </summary>
         /// <value>
-        /// <c>true</c> when a SSH_MSG_CHANNEL_CLOSE message has been sent to the other party;
-        /// otherwise, <c>false</c>.
+        /// <see langword="true"/> when a SSH_MSG_CHANNEL_CLOSE message has been sent to the other party;
+        /// otherwise, <see langword="false"/>.
         /// </value>
         private bool _closeMessageSent;
 
@@ -39,26 +39,26 @@ internal abstract class Channel : IChannel
         /// party.
         /// </summary>
         /// <value>
-        /// <c>true</c> when a SSH_MSG_CHANNEL_CLOSE message has been received from the other party;
-        /// otherwise, <c>false</c>.
+        /// <see langword="true"/> when a SSH_MSG_CHANNEL_CLOSE message has been received from the other party;
+        /// otherwise, <see langword="false"/>.
         /// </value>
         private bool _closeMessageReceived;
 
         /// <summary>
         /// Holds a value indicating whether the SSH_MSG_CHANNEL_EOF has been received from the other party.
         /// </summary>
         /// <value>
-        /// <c>true</c> when a SSH_MSG_CHANNEL_EOF message has been received from the other party;
-        /// otherwise, <c>false</c>.
+        /// <see langword="true"/> when a SSH_MSG_CHANNEL_EOF message has been received from the other party;
+        /// otherwise, <see langword="false"/>.
         /// </value>
         private bool _eofMessageReceived;
 
         /// <summary>
         /// Holds a value indicating whether the SSH_MSG_CHANNEL_EOF has been sent to the remote party.
         /// </summary>
         /// <value>
-        /// <c>true</c> when a SSH_MSG_CHANNEL_EOF message has been sent to the remote party;
-        /// otherwise, <c>false</c>.
+        /// <see langword="true"/> when a SSH_MSG_CHANNEL_EOF message has been sent to the remote party;
+        /// otherwise, <see langword="false"/>.
         /// </value>
         private bool _eofMessageSent;
 
@@ -221,7 +221,7 @@ private set
         /// Gets or sets a value indicating whether this channel is open.
         /// </summary>
         /// <value>
-        /// <c>true</c> if this channel is open; otherwise, <c>false</c>.
+        /// <see langword="true"/> if this channel is open; otherwise, <see langword="false"/>.
         /// </value>
         public bool IsOpen { get; protected set; }
 
@@ -264,7 +264,7 @@ private set
         /// Gets a value indicating whether the session is connected.
         /// </summary>
         /// <value>
-        /// <c>true</c> if the session is connected; otherwise, <c>false</c>.
+        /// <see langword="true"/> if the session is connected; otherwise, <see langword="false"/>.
         /// </value>
         protected bool IsConnected
         {
@@ -459,11 +459,11 @@ private void RaiseExceptionEvent(Exception exception)
         /// </summary>
         /// <param name="message">The message to send.</param>
         /// <returns>
-        /// <c>true</c> if the message was sent to the server; otherwise, <c>false</c>.
+        /// <see langword="true"/> if the message was sent to the server; otherwise, <see langword="false"/>.
         /// </returns>
         /// <exception cref="InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
         /// <remarks>
-        /// This methods returns <c>false</c> when the attempt to send the message results in a
+        /// This methods returns <see langword="false"/> when the attempt to send the message results in a
         /// <see cref="SocketException"/> or a <see cref="SshException"/>.
         /// </remarks>
         private bool TrySendMessage(Message message)
@@ -824,7 +824,7 @@ public void Dispose()
         /// <summary>
         /// Releases unmanaged and - optionally - managed resources.
         /// </summary>
-        /// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
+        /// <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
         protected virtual void Dispose(bool disposing)
         {
             if (!_isDisposed && disposing)

src/Renci.SshNet/Channels/ChannelSession.cs

@@ -129,7 +129,7 @@ protected override void Close()
         /// <param name="height">The height.</param>
         /// <param name="terminalModeValues">The terminal mode values.</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendPseudoTerminalRequest(string environmentVariable, uint columns, uint rows, uint width, uint height, IDictionary<TerminalModes, uint> terminalModeValues)
         {
@@ -142,12 +142,12 @@ public bool SendPseudoTerminalRequest(string environmentVariable, uint columns,
         /// <summary>
         /// Sends the X11 forwarding request.
         /// </summary>
-        /// <param name="isSingleConnection">if set to <c>true</c> the it is single connection.</param>
+        /// <param name="isSingleConnection">if set to <see langword="true"/> the it is single connection.</param>
         /// <param name="protocol">The protocol.</param>
         /// <param name="cookie">The cookie.</param>
         /// <param name="screenNumber">The screen number.</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendX11ForwardingRequest(bool isSingleConnection, string protocol, byte[] cookie, uint screenNumber)
         {
@@ -163,7 +163,7 @@ public bool SendX11ForwardingRequest(bool isSingleConnection, string protocol, b
         /// <param name="variableName">Name of the variable.</param>
         /// <param name="variableValue">The variable value.</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendEnvironmentVariableRequest(string variableName, string variableValue)
         {
@@ -177,7 +177,7 @@ public bool SendEnvironmentVariableRequest(string variableName, string variableV
         /// Sends the shell request.
         /// </summary>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendShellRequest()
         {
@@ -192,7 +192,7 @@ public bool SendShellRequest()
         /// </summary>
         /// <param name="command">The command.</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendExecRequest(string command)
         {
@@ -207,7 +207,7 @@ public bool SendExecRequest(string command)
         /// </summary>
         /// <param name="breakLength">Length of the break.</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendBreakRequest(uint breakLength)
         {
@@ -222,7 +222,7 @@ public bool SendBreakRequest(uint breakLength)
         /// </summary>
         /// <param name="subsystem">The subsystem.</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendSubsystemRequest(string subsystem)
         {
@@ -240,7 +240,7 @@ public bool SendSubsystemRequest(string subsystem)
         /// <param name="width">The width.</param>
         /// <param name="height">The height.</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendWindowChangeRequest(uint columns, uint rows, uint width, uint height)
         {
@@ -251,9 +251,9 @@ public bool SendWindowChangeRequest(uint columns, uint rows, uint width, uint he
         /// <summary>
         /// Sends the local flow request.
         /// </summary>
-        /// <param name="clientCanDo">if set to <c>true</c> [client can do].</param>
+        /// <param name="clientCanDo">if set to <see langword="true"/> [client can do].</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendLocalFlowRequest(bool clientCanDo)
         {
@@ -266,7 +266,7 @@ public bool SendLocalFlowRequest(bool clientCanDo)
         /// </summary>
         /// <param name="signalName">Name of the signal.</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendSignalRequest(string signalName)
         {
@@ -279,7 +279,7 @@ public bool SendSignalRequest(string signalName)
         /// </summary>
         /// <param name="exitStatus">The exit status.</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendExitStatusRequest(uint exitStatus)
         {
@@ -291,11 +291,11 @@ public bool SendExitStatusRequest(uint exitStatus)
         /// Sends the exit signal request.
         /// </summary>
         /// <param name="signalName">Name of the signal.</param>
-        /// <param name="coreDumped">if set to <c>true</c> [core dumped].</param>
+        /// <param name="coreDumped">if set to <see langword="true"/> [core dumped].</param>
         /// <param name="errorMessage">The error message.</param>
         /// <param name="language">The language.</param>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendExitSignalRequest(string signalName, bool coreDumped, string errorMessage, string language)
         {
@@ -307,7 +307,7 @@ public bool SendExitSignalRequest(string signalName, bool coreDumped, string err
         /// Sends eow@openssh.com request.
         /// </summary>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendEndOfWriteRequest()
         {
@@ -321,7 +321,7 @@ public bool SendEndOfWriteRequest()
         /// Sends keepalive@openssh.com request.
         /// </summary>
         /// <returns>
-        /// <c>true</c> if request was successful; otherwise <c>false</c>.
+        /// <see langword="true"/> if request was successful; otherwise <see langword="false"/>.
         /// </returns>
         public bool SendKeepAliveRequest()
         {

src/Renci.SshNet/Channels/ClientChannel.cs

@@ -113,7 +113,7 @@ protected override void Dispose(bool disposing)
         /// </summary>
         /// <param name="session">The session.</param>
         /// <remarks>
-        /// Does nothing when <paramref name="session"/> is <c>null</c>.
+        /// Does nothing when <paramref name="session"/> is <see langword="null"/>.
         /// </remarks>
         private void UnsubscribeFromSessionEvents(ISession session)
         {