Objective-C - заголовок документа, а не файл кода?

Я хотел бы начать правильно документировать свой код, но не уверен, где лучше всего поместить его для чтения HeaderDoc. Я прочитал следующую фразу в документации HeaderDoc, которая заставляет меня думать, что предполагаемое местоположение (с точки зрения Apple) находится в файлах заголовка?

Вместо указания одного входного файла (как указано выше), вы можете указать входной каталог, если хотите. HeaderDoc будет обрабатывать каждый файл.h во входном каталоге (и все его подкаталоги), генерируя выходной каталог файлов HTML для каждого заголовка, который содержит комментарии HeaderDoc.

Это правильно? Отличается ли я от того, где я размещаю свою документацию?

0 ответов

Другие вопросы по тегам