Book Image

Android Studio Essentials

By : Belén Cruz Zapata
Book Image

Android Studio Essentials

By: Belén Cruz Zapata

Overview of this book

<p>Android Studio is an IDE that is based on the JetBrains IntelliJ IDEA. It gives developers a unique platform to develop and debug Android apps using various developer tools. It has a wide array of features such as live layout facility, Gradle build support, and template-based wizards, which makes it a preferred choice for developers.</p> <p>Starting off with the basic installation and configuration of Android Studio, this book aids you in building a new project by helping you to create a custom launcher icon and guiding you to choose your activity. You then gain an insight on the additional tools provided in Android Studio, namely the Software Development Kit (SDK) Manager, Android Virtual Device (AVD) Manager, and Javadoc.</p> <p>Finally, it helps you to familiarize yourself with the Help section in Android Studio that enables you to search for the help you might require in different scenarios.</p>
Table of Contents (17 chapters)
Android Studio Essentials
Credits
About the Author
About the Reviewers
www.PacktPub.com
Preface
Index

Generating a Javadoc


A Javadoc is a utility to document Java code in HTML format. The Javadoc documentation is generated from comments and tags added to Java classes or methods. The comments start with the /** string and end with */. Inside these comments, tags can be added, such as @param to describe a method parameter,@throws to describe an exception that can be thrown by the method, or @version to indicate the version of the class or method.

The use of a Javadoc is integrated in Android Studio. We can use code completion when typing the Javadoc comments and the documentation will appear in the pop-up tool tips of the code elements.

To generate a complete Javadoc, we have to write the Javadoc comments about our classes and methods. Open the main activity of our project to add the Javadoc comments to the onAcceptClick method we created in Chapter 5, Creating User Interfaces. Place the caret on the line before the method declaration, type /**, and press Enter. The Javadoc comments are automatically...