2015-11-16 2 views
1

Я хотел бы добавить документацию по разметке к функции Swift, которая реализована из-за того, что класс соответствует UICollectionViewDataSource. Например:Быстрые комментарии документации для переопределенных методов?

/// 
/// - returns: Why is this documentation ignored? 
/// 
override func collectionView(collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int { 
    return 2 
} 

Видимо, мои комментарии игнорируются и генерируемая документация остается один наследуется из определения договоров (или другое место по умолчанию), для быстрой справки (в Xcode 7.1.1) включает в себя этот текст:

Возвращает Количество строк в разделе.

Как я могу «переопределить» такую ​​документацию по умолчанию, чтобы вызывать изменения в моей реализации?

ответ

1

Похоже, что в переопределенных функциях вам нужно дать многострочный комментарий (кажется, что/* */не работает, вам нужно/** * /) вместо нескольких одиночных строк. Что интересно, несколько однострочных комментариев отлично работают для неперекрываемых функций. Что еще более интересно, когда вы вводите метод, вы получаете правильный, переопределенный комментарий, но Quick Help просто игнорирует его, как только вы его вводите, и нажмите alt.

Пример:

/** 
    Works fine as you are typing. 
*/ 
override func viewDidAppear() { 
    print("test") 
} 
+0

И если/** ... */следует однострочных комментариев // перед сигнатуру метода, он также не работает. Возможно, это скорее ошибка, чем функция. – Drux

Смежные вопросы