2013-09-25 1 views
2

Так как XCode 5 теперь поддерживает чтение комментариев заголовков непосредственно из файлов заголовков, становится все более интересным, чтобы документировать функциональность согласованным образом.автоматически вставляет комментарии заголовка doc в Objective C?

Поэтому я пытаюсь найти инструмент, который может автоматически вставлять комментарии в формате doc в заголовочные файлы Objective C, но не может их найти?

В основном я хотел бы взял, что мог бы написать что-то вроде:

/*! 
    <desc method.> 
    @param parmA 
     <desc of parmA> 
    @param parmB 
     <desc of parmB> 
    @result 
     <desc of result> 
*/ 
- (CO2 *)doSomething:(typeName)parmA withSomething:(typeName)parmB; 

ответ

9

Я нашел это очень удобный плагин Xcode, чтобы написать все комментарий по умолчанию код для вас.

https://github.com/onevcat/VVDocumenter-Xcode

EDIT

По Xcode 8, есть новый ярлык доступен, который имеет такое же поведение, как плагин VVDocumenter.

Поместите курсор над любой функции, класса, структуры, ... и ударил ⌘ + ⌥ + /

Это создаст комментарий соответственно, где вы разместили курсор.

+0

Похоже, это идеальное решение! Однако я не могу заставить его работать. Вместо того, чтобы вставлять комментарий, кажется, просто вставляйте все, что у меня есть в моем буфере обмена. Вам удалось заставить его работать? – EsbenB

+1

Да, вы должны загрузить основную ветвь, построить цель VVDocumenter-Xcode и после этого перезапустить Xcode. Это сработало для меня. –

+0

ahh Я узнал, что другой инструмент, который я использую (вырезать/вставлять файлы), вызывает проблемы. Кажется, отличный инструмент! Thanx – EsbenB

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