JsDoc Toolkitによる開発効率向上を
目指して

/** 
 * @fileOverview 入力チェック機能を保有するファイルです。<br>
 * 
 * @author 遠藤 太志郎
 * @version 1.0.0
 */
 
/**
 * 
 * @class 入力チェッククラス<br>
 * 画面の入力チェックを行うための機能を集めたクラスです。<br>
 * 全メソッドがstaticになっています。
 * 
 */
var InputCheck = {
    /**
     * 半角数字チェック<br>
     * <br>
     * 照合対象文字列が全て半角数字であるかどうかをチェックする。
     * 
     * @param {String} 	str 照合対象文字列
     * @return {boolean}    true:全て半角数字の場合
     *                      false:半角数字以外が含まれる場合
     * @example 
     * var str = "エラーワード";
     * if(InputCheck.isNumeric(str)){
     * 	alert("半角数字を入力してください。");
     * 	return false;
     * }else{
     * 	return true;
     * }
     */
    isNumeric: function(str) {
        if(str.match(/[^0-9]/g)){
            return false;
        }else{
            return true;
        }
    }
}

/** 
 * @fileOverview JavaScript組み込みクラスであるString型を拡張するJSファイルです。<br>
 * 
 * @author 遠藤 太志郎
 * @version 1.0.0
 */
 
/**
 * 空白を取り除く。<br>
 * <br>
 * 文字列の左右から空白スペースを取り除きます。
 *
 * @param {String} str 対象文字列
 * @return {String} 空白スペースを取り除いた文字列
 * 
 * @example 引数の文字列から空白スペースを取り除く。
 * var str = "     ABCDE     "
 * str.trim();
 * 
 */
String.prototype.trim = function() {
    return this.replace(/^[ ]+|[ ]+$/g, '');
}

/** 
 * @fileOverview クラス化されていない、グローバルのfunction機能を保有するファイルです。
 * 
 * @author 遠藤 太志郎
 * @version 1.0.0
 */
 
/**
 * 名前の表示

 * 

 * 名前をアラートで表示する。
 * 
 * @return {void}
 * @param {String}  name 名前
 * @param {String}  familyName 苗字
 * 
 * @example 
 * viewName("遠藤","太志郎")
 */
function viewName(name,familyName){
    
    alert("私の名前は" + name + familyName + "です。");
    
}
 
 
/**
 * @augments viewName
 * @return {void} 
 * @param {String}  name 名前
 * @param {String}  familyName 苗字
 */
function test(name,familyName){
    
    alert("私の名前は" + name + familyName + "です。");
    
}