I am writing documentation about a function in Visual Studio 2017. At some point, I need a new line symbol in order to obtain more smooth style of the documentation. The example situation is presented below:
public interface IPersonService : IDisposable
{
/// <summary>
/// Procedure that returns a list of people with the given first and last name.
///
/// <para>
/// First and last names are not case sensitive. ('friedrich schiller' == 'fRieDrich scHIller')
/// </para>
/// <example>
/// The following example returns a list of people with the first name 'friedrich' and the last name 'schiller': (newline should come here)
/// <code>
/// IList <Person> personList = _personService.GetList("friedrich","schiller");
/// </code>
/// </example>
/// </summary>
/// <param name="name">Name of the person being called. It cannot be null. It is not case sensitive.</param>
/// <param name="surname">Surname of the person being called. It cannot be null. It is not case sensitive.</param>
/// <returns>
/// IList- Person, List of people with name and surname,
/// list with 0 elements- If there is no person with your name and surname.
/// </returns>
IList<Person> GetList(string name, string surname);
}
I read the “Recommended XML tags for C# documentation comments” but cannot find it. “n” does not work. Do you know how I can solve this? Thanks in advance.