Я использовал возможность Xcode 5 документировать свой код с поддерживаемым синтаксисом комментариев (см. этот вопрос SO). Xcode 6 поддерживает его с источниками Objective-C, к сожалению, не с источниками Swift.
Я хотел бы выполнить встроенную документацию по источнику .swift. Любая идея, как это сделать или лучшие практики?
Заранее спасибо,
Луис
Вроде как еще можно добавить описания функций:
/**
This is a description of my function
*/
func myFunc() {
}
///this is a description of my second function
func myFunc2(){
}
но ни один из тегов headerdoc в настоящее время не поддерживается. Вероятно, он будет поддерживаться к моменту выпуска Xcode 6.
Вот некоторые вещи, которые работают для документирования быстрого кода в Xcode 6. Он очень глючный и чувствителен к двоеточиям, но это лучше, чем ничего:
class Foo {
/// This method does things.
/// Here are the steps you should follow to use this method
///
/// 1. Prepare your thing
/// 2. Tell all your friends about the thing.
/// 3. Call this method to do the thing.
///
/// Here are some bullet points to remember
///
/// * Do it right
/// * Do it now
/// * Don't run with scissors (unless it's tuesday)
///
/// :param: name The name of the thing you want to do
/// :returns: a message telling you we did the thing
func doThing(name : String) -> String {
return "Did the \(name) thing";
}
}
Вышеупомянутое отображается в Quick Help, как и следовало ожидать, с форматированными числовыми списками, маркерами, документацией по параметрам и возвращаемым значениям.
Ничто из этого не задокументировано — зарегистрируйте радар, чтобы помочь им.
