Java
Android
android開発

英語でのコメントの書き方メモ

はじめに

プログラムのコメントは基本的に英語で書いている為、
自分にメモの作成

クラスヘッダーコメント

情報を保持する系のクラス

/**
 * This class is used to hold the ***.
 */

提供する系のクラス

/**
 * Provides ***.
 */

インターフェースクラス

/**
 * Defines a *** interface.
 * That any implementation of this interface can be used by inheritor's to handle a ***.
 */

メソッドコメント

フラグ設定関係

/**
 * Sets flag indicating whether *** is ***.
 */

判定関係

/**
 * Determines if *** is *** or not.
 *
 * @return Returns {@code true} if *** is ***, {@code false} otherwise.
 */

判定関係2

/**
 * Checks whether the given *** can be ***.
 *
 * @return Returns {@code true} if the given *** can be ***, {@code false} if they cannot be ***.
 */

何かを取得する関係

/**
 * Gets the *** with the given {@code ***}.
 *
 * @return Returns the ***. Returns {@code null} if *** doesn't have a specified ***.
 */

その他

enum系

/**
 * Enumeration for ***.
 */