Using Xcode to generate API documentation---01 INTRODUCTION

Source: Internet
Author: User

There are three main tools for generating technical documentation: 1.headerdoc, Pros: Xcode's own document generation tool, command-line-based operation, and ease of use.  Cons: However, you can only generate comments in/*! */format. Another drawback is that each class file corresponds to a comment file, and the index file does not have the last summary navigation.   2.doxygen, Advantages: Powerful, the most support language in the three, no headerdoc shortcomings, based on the graphical operation of the interface, Cons: More configuration, you can generate HTML documents or PDF documents.   3.appledoc. Pros: Command-line-based operation, ease of use, no Headerdoc disadvantage, default generated document style and Apple's official document is consistent, namely Docset, integrated into Xcode is identical to Apple's official document, By holding down option in the source code and then clicking, you can bring up the help of the appropriate method. Of course, you can also generate HTML documents.   

Using Xcode to generate API documentation---01 INTRODUCTION

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.