Open-source framework: appledoc

Introduction:

AppledocIs one that can help you generateObjective-CThe auxiliary tool for code annotation. The annotation API documentation generated by appledoc is consistent with the API documentation of the apple class library.

This allowsXcodeCan identify our own API documentation.

Refer:

1: Install brew on Mac

Http://blog.csdn.net/chenyi8888/article/details/7345113

2: use objective-C's document generation tool: appledoc

Http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode-doc/

Installation:

AppledocThe GitHub hosting address of is as follows:

Https://github.com/tomaz/appledoc

Use this versionBrewInstallAppledoc

Command:Sudo brew install appledoc

If you have not installed brew in advance, the above command will certainly become invalid.

Run the following command to install brew:

Command: curl-http://github.com/mxcl/homebrew/tarball/master | sudo tar xvz-C/Usr/local-- Strip 1

Note the path marked in red in the preceding command.

Check whether you have the path, as shown in:

If not, manually create one and execute the command to install brew.

Check whether brew is successfully installed.

Command:Brew

If a bunch of brew instructions are displayed, the installation is successful.

Go back to our appledoc and run the following command:

Command:Sudo brew install appledoc

The command may still fail because the specified path does not have sufficient read/write permissions.

/Usr/local/binIs not writable. You shoshould change its permissions.

Set the read and write permissions for the path marked in red.

After the installation is complete, uninstall appledoc. At this time, appledoc is half installed and not fully installed.

Command:Brew uninstall appledoc

After the installation, run the installation again.

It should have been installed successfully.

Check whether the installation is successful and call up the appledoc help document.

Command:Appledoc -- Help

Usage:

Use the following command to generate an API document

appledoc --project-name yushuyi12345677            --project-company "xiaoyu123"          --company-id aaaa           --output /Users/yushuyi/Desktop              /Users/yushuyi/Desktop/MultiFTPTask/MultiFTPTask/Classes

Note: five parameters are required in the preceding command:

1: Project name

2: Company Name

3: Project ID

4: Output path of the generated result

5: the class under which the scan path is located.

This command traverses all classes based on the specified path. After the generation is successful, appledoc creates a new text file to record the generation, this file is stored in the -- output.

When executing the preceding command, make sure that all line breaks are deleted before execution.

The generated documents are automatically stored in the default xcode document directory:

~ /Library/developer/shared/documentation/docsets

If no exception occurs, you can view the document generated after the command is executed in the directory:

We all know that press and holdOptionClick a method or attribute name.

Summary: