NewLine trong tóm tắt đối tượng


98

Lời chào hỏi

Khi thiết lập một bản tóm tắt cho một thuộc tính / trường / phương thức, v.v .. có thể có một dòng mới trong đó không?

/// <summary>
/// This is line 1
/// This is line 2
/// </summary>
public bool TestLine { get; set; }

Khi tôi đặt nó, nó sẽ hiển thị khi di chuột qua:

bool TestLine
This is line 1 This is line 2

Nhưng tôi muốn nó hiển thị như sau:

bool TestLine
This is line 1 
This is line 2

Tôi đã thử sử dụng \nnhưng điều đó không hoạt động. Có cách nào để hoàn thành việc này không?

Câu trả lời:


186

Bạn muốn sử dụng một số thứ như thế này

/// <summary> 
/// Your Main comment 
/// <para>This is line 1</para> 
/// <para>This is line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

1
@YetA AnotherUser, còn dòng trống thì sao?
Behzad

1
@Behzad hãy thử sử dụng <para>&nbsp;</para>.
YetA AnotherUser

15
Tôi ghét những dòng thêm :(
Jan Machacek

10
Trong Visual Studio 2017 IDE, "giải pháp" ở trên thực sự hiển thị một DÒNG NGÂN HÀNG duy nhất giữa dòng 1 và dòng 2 (nghĩa là một dòng mới sau dòng 1 theo sau là dòng trống rồi đến dòng 2) - điều này không giống như dòng mới, như OP yêu cầu. Đó có phải là một lỗi trong VS 2017 IDE - hay tất cả những người đã bỏ phiếu không thấy rằng câu trả lời này không tạo ra những gì OP hiển thị như đầu ra mong muốn?
Jazimov

Đó là một đoạn mới, không phải một dòng mới. Tôi cảm thấy rằng cú pháp tài liệu có phần hạn chế.
GrizzlyMcBear

33

Đúng:

/// <summary> 
/// Main comment 
/// <para>Line 1</para> 
/// <para>Line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

11

Đây có thể là một chủ đề cũ nhưng tôi đã tìm kiếm một trình duyệt khi sử dụng Visual Studio 2019 . Tôi muốn ngắt đoạn và dòng. Những điều sau đây hoạt động tốt cho tôi:

/// <summary>
/// <para>parameter name="guidType" options:</para>
/// <br>0 = SequentialAsString</br>
/// <br>1 = SequentialAsBinary</br>
/// <br>2 = SequentialAtEnd</br>
/// </summary>

Tạo ra những thứ sau:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

4
Đối với VS2019 trở đi, câu trả lời này đúng về mặt kỹ thuật hơn câu trả lời được chấp nhận.
Riaan Walters

Bạn cũng có thể chỉ sử dụng <br /> ở cuối dòng trong VS2019. Các giải pháp này tạo ra một ngắt dòng thực sự chứ không phải một đoạn văn mới có dòng trống! Cảm ơn
Phillip S

5

Bạn có thể sử dụng <para />để thêm một dòng mới trong phần tóm tắt:

/// <summary> 
/// Main comment<para />
/// Line 1<para />
/// Line 2<para />
/// </summary>
public bool TestLine { get; set; }

Giống như:

Main comment
Line 1
Line 2

Trân trọng!


2

Tôi chỉ thêm điều này cho bất kỳ ai đang sử dụng Xamarin Studio như tôi. Tôi thấy rằng không có giải pháp nào ở trên phù hợp với tôi, nhưng giải pháp này đã làm được:

/// <summary>
/// Main summarry line.
/// <para></para>
/// <para></para>
/// Your secondary summary
/// </summary>

Điều này cho kết quả sau:

Summary  
Main summary line.

Your secondary summary

1

Nếu bạn đang sử dụng Swashbuckle (thư viện tích hợp API Web Swagger) thì <para></para>nên được thay thế bằng <p></p><br/>cũng có thể được sử dụng.

vì vậy sau đây

    /// <para>
    ///     Flag1, Flag2
    ///     - bool flags, optional.
    /// </para>

trở thành

    /// <p>
    ///     Flag1, Flag2<br/>
    ///     - bool flags, optional.
    /// </p>

Vấn đề đã được mô tả ở đây: Làm thế nào để thêm ngắt dòng vào tài liệu Swashbuckle? - sử dụng cấu hình đặc biệt, bình luận của domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/258 - về <br/>cách sử dụng.


0

Bạn có thể thêm thẻ para một cách hợp pháp, nhưng điều này thực sự tạo ra một đoạn mới cho mỗi dòng mới và khoảng cách dòng sẽ xuất hiện.
Cá nhân tôi thêm 1 para xung quanh đoạn văn và sau đó brgắn thẻ vào cuối các dòng tôi muốn ngắt, điều này duy trì khoảng cách dòng phù hợp:

/// <summary> 
/// <para>Main comment<br /> 
/// Line 1<br />
/// Line 2</para> 
/// </summary>
public bool TestLine { get; set; }

3
Điều này không hiệu quả và không có gì khác về khoảng cách với <para>. Bạn đang sử dụng phiên bản VS / .Net nào?
Dani

2
Các thẻ HTML sẽ bị bỏ qua summary, ngay cả khi chúng nằm trong parathẻ.
Lazaro Fernandes Lima Suleiman

-7

Tôi khuyên bạn nên sử dụng định dạng này nếu bạn muốn có nhiều dòng trong bản tóm tắt mà không làm cho nó phức tạp. Nó sẽ hoạt động nếu bạn sử dụng thẻ <br /> sau mỗi dòng. (sử dụng nó ở bất kỳ vị trí nào bên trong văn bản sẽ tạo một dòng mới nơi cũng có thẻ.)

Mặc dù vậy, lưu ý rằng nếu bạn có khoảng trắng sau thẻ <br />, bạn sẽ có thêm một khoảng trắng ở dòng tiếp theo. Vì vậy, bạn muốn có cùng một lượng không gian trên mỗi dòng, vì vậy mọi hàng sẽ nằm trên một đường thẳng.

/// <summary>
/// This is line 1<br />
/// This is line 2<br />
/// This is line 3<br />
/// </summary>
public bool TestLine { get; set; }

3
Điều đầu tiên tôi đã thử trước khi tìm giải pháp vì điều đó không hoạt động!
Philippe

Cũng có tác dụng với tôi. Bình chọn
AlexWei
Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.