Я использую Xcode 10 с Swift 5:
В моем коде есть пара больших функций, которые требуют подробного многострочного описания. Пример:
/**
This is paragraph 1.
This is paragraph 2.
This is paragraph 3.
*/
func Foo() {
//Bla
}
Что создает Xcode:
Пункты 2 и 3 являются продолжением пункта 1, поэтому раздражает, что они находятся в другом разделе.
Как мне сохранить все три параграфа в одном и том же разделе (мне все равно, если это «краткое изложение», «описание», ... один)?
Мне известна документация по документации здесь , но нет объяснения, как это сделать точно, и единственный пример многострочного комментария (прокрутите вниз до: "Вызов этого метода увеличивает значение" ...) отсутствует именно эта строка текста на скриншоте всплывающего окна "документация".
Edit:
Еще хуже, если вы используете такой список, потому что заголовок остается в разделе «Сводка», а элементы списка помещаются в раздел «Обсуждение»:
/**
List Title:
- Item 1
- Item 2
- Item 3
*/