#swift #xcode #documentation #markup
#быстрый #xcode #Документация #разметка
Вопрос:
Привет, ребята.
Я использую Xcode для продолжения существующего приложения, и я знаю, что лучший способ документировать этот конкретный проект-это наценки (/// вместо //). Проблема в том, что существует слишком много функций, и использование разметок для объяснения всех из них затруднило бы визуализацию кода. Вместо этого я действительно хочу разметить переменные, функции, методы и так далее… но в других файлах, если это возможно.
Могу ли я каким-то образом разметить функцию, объявленную в другом файле «.swift»? Как? Я понял, что мой код значительно улучшится с этими пометками для моих коллег, но я должен действительно подчеркнуть, насколько неразборчивыми могут стать файлы, в которых объявлены переменные/функции.
PS: Здесь новичок StackOverflow. Если что-то пойдет не так, как предписано нашим сообществом, пожалуйста, дайте мне знать.
Заранее спасибо! 😉
Комментарии:
1. Вы должны писать свои комментарии/разметку рядом с кодом, который они описывают, все остальное будет означать только больше работы, гораздо меньшую ремонтопригодность и общую путаницу IMO.
2. Обычно это имеет смысл, но проект гигантский, и наценки в целом только облегчают визуализацию, учитывая, что вам нужно только навести курсор мыши, чтобы узнать подробности (резюме, параметры и т. Д.). Просто мнение, но я думаю, что в подобных случаях внешние наценки оправданны, хотя я не знаю, возможны ли они. Только кажется проблематичным, потому что это прямо над объявлениями, и, насколько я знаю, я не могу объявить функцию и «сделать» эту функцию позже.
3. @Guaringue Совет по Xcode — сделайте
control command up arrowэто, чтобы увидеть интерфейс вашего файла. Если вы задокументировали такие вещи, как протоколы/классы, и, например, реализуете/наследуете их, вы также увидите документацию, «скопированную» поверх