Мне известно о комментарии к документации Swift и многих его тегах, которые используются для документирования кода, например: param :,: return: и т. Д.
Но я не могу найти или выяснить эквивалент комментария в документации @code Objective-C для Swift. Я хочу включить пример кода в описание некоторого класса в моем проекте с открытым исходным кодом, но я не уверен, как это сделать.
Может ли кто-нибудь пролить свет на то, как это сделать, или что это вообще возможно на данном этапе?
Используя appledoc, вам просто нужно сделать отступ в 4 пробела в коде.
/*!
Documentation for the class.
Here is a code sample
func code()
{
//code
}
*/
Вы заметите, что параметры lot из форматирования аналогичны параметрам Stack Overflow! Оба они используют Markdown для форматирования.
Я просто впервые задокументировал проект с помощью appledoc, поэтому у меня есть несколько страниц в недавней истории. Функция code задокументирована здесь
Относительно вашего вопроса о :code: @code вариантах синтаксиса. Директивы Appledoc допускают любой непробельный символ, за которым следует ключевое слово. Для Xcode документация - это просто комментарий.
Префикс директив: хотя все директивы в приведенных выше примерах используют в качестве префикса знак «@», вы можете вместо этого использовать любой символ без пробелов, например \ param, $ param,% param и т. Д.
[Источник] < / sup>
Однако кажется, что общий @code не поддерживается appledoc в отличие от других инструментов документации, таких как doxygen .
согласно ссылке здесь вы можете написать документацию для блока кода, как показано ниже.
/**
The area of the `Shape` instance.
Computation depends on the shape of the instance. For a triangle, `area` will be equivalent to:
let height = triangle.calculateHeight()
let area = triangle.base * height / 2
*/
var area: CGFloat { get }
