`
TRAMP_ZZY
  • 浏览: 140185 次
社区版块
存档分类
最新评论

Javadoc 注释书写规范

    博客分类:
  • Java
阅读更多
package com.datastructure.one;
/**
 *	The TemperatureConversion Java applicatoin prints a table
 *	converting Celsius to Fahrenheit degress.
 * @author zhangzhaoyu
 * <a href="mailto:zhangzhaoyu@163.com>">zhangzhaoyu@163.com</a>
 */
public class TemperatureConversion {

	
	public static void main(String[] args) {
		
		final double TABLE_BEGIN = -50.0;
		final double TABLE_END = 50.0;
		final double TABLE_STEP = 10.0;
		
		double celsius;
		double fahrenheit;
		
		System.out.println("TEMPERATURE CONVERSION");
		System.out.println("----------------------");
		System.out.println("Celsius     Fahrenheit");
		for (celsius = TABLE_BEGIN; celsius < TABLE_END; celsius += TABLE_STEP ) {
			fahrenheit = celsiusToFahrenheit(celsius);
			System.out.printf("%6.2fC", celsius);
			System.out.printf("%1.4fF\n", fahrenheit);
		}
		System.out.println("----------------------");
		
		
	}
	/**
	 * Convert a temperature from Celius to Fahrenheit.
	 * @param c
	 * 	a temperature in Celsius degress
	 * @precondition
	 * 	c >= -273.15
	 * @return
	 * 	the temperature c converted to Fahrenheit
	 * @postcondition
	 * 	The Fahrenheit temperature equivalent to c has been
	 * 	printed to System.out
	 * @throws IllegalArgumentException
	 * 	Indicates that c is less than the smallest Celsius
	 * 	temperature(-273.15)
	 */
	public static double celsiusToFahrenheit(double c) {
		
		final double MINIMUM_CELSIUS = -273.15;
		if (c < MINIMUM_CELSIUS) {
			throw new IllegalArgumentException("Argument " + c + " is too small.");
		}
		return (9.0/5.0)*c + 32;
	}

}
分享到:
评论

相关推荐

    java 书写规范

    类和接口的定义应以 JavaDoc 文档注释开头,包括类的描述、作者、版本信息等。变量、实例、方法等应以 public、protected、private 排列。 缩进和格式 缩进和格式是 Java 代码书写规范的重要部分。每行代码不应...

    java代码书写规范

    ### Java代码书写规范 #### 一、通用规范 ##### 1.1 命名规范 1. **使用全单词表示**:为了提高代码的可读性和易理解性,建议使用完整的单词而非缩写词来命名变量、方法等。例如,使用`firstName`而非`fn`。 2. *...

    java编码注释和doc自动生成

    首先,Java提供了多种注释类型,包括单行注释、多行注释和Javadoc注释。单行注释以`//`开始,适用于快速添加临时或简单的说明。多行注释以`/*`开始,以`*/`结束,适合对一段代码进行详细解释。而Javadoc注释则是以`/...

    java编程规范,包含命名、代码格式、代码优化、注释等

    此外,Javadoc注释(/** ... */)用于生成API文档。 2. 注释内容:注释应简洁明了,描述代码的功能、目的和使用方法,避免过于冗长。 3. 注释格式:注释应保持整洁,避免过多的空格和换行。Javadoc注释应遵循特定...

    java编程规范

    ##### 3.1 注释书写规范 - 使用`//`进行单行注释,用于解释一行代码的功能。 - 使用`/* */`进行多行注释,用于较长的说明或注释掉不再使用的代码段。 - 类、接口、方法等声明前使用Javadoc格式的注释,提供详细的...

    华为代码规范代码模板

    同时,规范也规定了注释的书写格式,如使用Javadoc标准,使代码更易于通过API文档生成工具生成文档。 “对代码进行格式化”是另一个关键点。代码格式化是指将源代码按照一定的规则排列整齐,包括缩进、空格、换行等...

    JAVA编码规范.doc

    这些规则涵盖了变量命名、函数设计、注释书写等多个方面,旨在保持代码风格的一致性,降低理解和修改代码的难度,提升整体项目质量。例如,编码规范会规定变量名应具有描述性,避免使用无意义的缩写,以便其他开发者...

    Xcode 快速注释 ///注释

    首先,"VVDocumenter-Xcode"是一个开源项目,它的目的是使Xcode支持类似JavaDoc或Doxygen的三重斜线注释语法(///)。这个插件可以让你通过输入"///"来快速生成符合Apple文档风格的多行注释,而无需手动填写每个字段...

    Java软件开发文档代码规范

    javadoc注释标签语法包括: - @author:标记该类模块的开发者。 - @version:标记该类模块的版本。 - @see:为类、属性、方法提供参考转向的链接。 - @param:描述方法中的参数。 - @return:描述方法的返回值。 - @...

    Eclipse 添加注释模板

    这个功能允许开发者快速插入预定义的注释模式,极大地提高了编码速度和代码规范性。下面我们将深入探讨如何在Eclipse中设置和使用注释模板。 首先,让我们理解什么是注释模板。注释模板是预先定义的一段文本,通常...

    eclipse_中的注释_快捷键

    按下此组合键后,Eclipse会在光标处自动插入一个Javadoc注释模板,开发者只需填写具体内容即可。 - **应用场景**:在编写公共接口、方法或其他需要文档说明的地方时使用,有助于提高代码可读性和维护性。 3. **...

    java注释模板

    这里,`${todo}`应该填写类的具体描述,`${tags}`可以用于添加额外的Javadoc标签。 3. **字段(Fields)注释模板**: 字段注释模板用于解释变量的作用。例如: ```java /** * @Fields ${field} : ${todo}(用一句...

    myeclipse简单注释模板(更新)

    你可以在这里定义各种注释样式,如单行注释、多行注释、Javadoc注释等。例如,为每个方法添加一段描述其功能、参数和返回值的Javadoc模板,只需输入特定快捷键,MyEclipse就能自动生成规范的注释,避免了逐行手写。 ...

    Java程序编码规范

    - Javadoc注释应遵循特定格式,例如使用`@param`、`@return`、`@throws`等标签来描述参数、返回值和可能抛出的异常。 遵循这些编码规范,可以使代码更加整洁,易于理解,从而提高团队合作的效率和代码质量。在实际...

    java代码编写规范.doc

    1. 注释:注释应该使用 JavaDoc 风格,例如:/ */。 2. 类和接口注释:类和接口注释应该描述类或接口的作用和用途,例如:/ * This is a sample class. */ 3. 方法注释:方法注释应该描述方法的作用和用途,例如:...

    java案例代码规范

    4. **成员变量**:公共成员变量应提供JavaDoc注释,以解释其用途。受保护的、私有的和包级私有的成员变量,如果其名称已经足够清晰,可以不加注释。 5. **存取方法**:简单的存取方法可以写在同一行内,以节省空间...

    阿里编码规范

    - **4.2.5 一行一个语句**:避免在一行内书写多条语句。 - **4.2.6 列限制**:每行代码长度限制为80或100个字符。 - **4.2.7 自动换行**:当达到列限制时,应自动换行。 #### 五、命名规范 **5.1 包名** - 采用全...

    Java语言编码规范Sun.pdf

    此外,还要求开发者书写文档注释,以便通过Javadoc工具生成API文档。 在声明部分,规范规定了每行声明的变量数量,建议对变量进行初始化,并指明变量的布局以及类和接口的声明方式。 语句方面,规范要求开发者使用...

Global site tag (gtag.js) - Google Analytics