Comments in Android

-

Introduction

There are three types of comments you can use in Android Studio

  1.  Line Comment - //
  2. Block Comment - /* */
  3. JavaDoc - /** */
This post is all about different tips and tricks which I found over the years of using JavaDocs from various projects.

JavaDoc is a utility that Java, Android or Kotlin developers can use with the help of installed Java SDK to generate code documentation.

This is a simple example of using JavaDoc comments in Android Studio.

With the help of the JavaDoc comments defined for setStartTime method we can get this kind of information snippet

Tips

  • You can use a file of a project with another file with the help of @link annotation used in JavaDoc. Syntax is {@link FileName}
 /**
  * A ViewModel used for the {@link ChronoActivity2}.
  */
  • You can define parameter names of a method with the help of @param annotaion. e.g.
 * @param startTime value for startTime
  • To Be Continued...

Reference

Comments

Post a Comment

Popular posts from this blog

SSLSocketFactory in Android

-
Image
Overview SSLSocketFactory is used to create secure sockets. Steps to follow First you have to create a key store. Open command prompt using Administrator login. Type " cd C:\Program Files\Java\jdk-14\bin ". Type the below command keytool -genkey -v -keystore my-key.keystore -alias my-key-alias-keyalg RSA -keysize 2048 -validity 10000 Follow the steps given in the screenshot: For - keyalg you can use RSA, DSA, EC to generate asymmetric key pair or use DES, 3DES to generate symmetric key pair. Then you have to generate a certificate Open command prompt using Administrator login. Type " cd C:\Program Files\Java\jdk-14\bin ". Type the below command keytool -certreq -alias "my-key-alias" -file mycertreq.csr -keystore my-key.keystore Follow the steps given in the screenshot. Note: The password , alias name , keystore name must be the same which you used while creating the keystore . An example of creating a subclass of SSLSocketFactory class TLSSocketFact
Read more

Dagger-Hilt in Android

-
Image
Overview Class without dependency injection: class Mobile { private var battery : Battery? = null private var processor : Processor? = null init { battery = Battery() processor = Processor() } } In the above line of code, when you create an object of a Mobile, then its constructor will have to create the object of Battery and Processor to initialize the properties of Mobile. Henceforth, it has to violate the principle defined by "Uncle Bob" i.e. 1st principle of Solid Principle (Single responsibility Principle).  In addition, we have to admit that whenever we are creating an object of Mobile, the class will create an object of Battery and Processor. In future, if we want to pass the object of Battery in the class then we are not allowed to do it because of scope limitation.  What is dependency injection? When an object of a class depends on the object of another classes that is dependency injection. class Mobile( var battery : Battery?
Read more

How to write files in Android?

-
Image
To write files in Android follow the following steps: Create a variable path with the help of Environment class provided by Android OS Create an object of File which indicates the directory, and pass the path string created earlier. Then use mkdir() method to create the directory. Create a string of file name. Create an object of File with indicates the file, and pass the file name string created earlier.  Check if the file exists. If not then use createNewFile() method to create the file. Create an object of FileWriter with the help of file object created earlier. Create an object of BufferedWriter with the help of fileWriter object created earlier.Create the string that you want to write on the file. Use write() method of the BufferedWriter object. Don't forget to close the object of BufferedWriter and FileWriter in this order. e.g. BufferedWriter output ; FileWriter filewriter ; String strTileText = "" ; String directoryName = "programming.notes" ; direc
Read more