Презентация Few words about how to write disputably nice code онлайн
На нашем сайте вы можете скачать и просмотреть онлайн доклад-презентацию на тему Few words about how to write disputably nice code абсолютно бесплатно. Урок-презентация на эту тему содержит всего 36 слайдов. Все материалы созданы в программе PowerPoint и имеют формат ppt или же pptx. Материалы и темы для презентаций взяты из открытых источников и загружены их авторами, за качество и достоверность информации в них администрация сайта не отвечает, все права принадлежат их создателям. Если вы нашли то, что искали, отблагодарите авторов - поделитесь ссылкой в социальных сетях, а наш сайт добавьте в закладки.
Оцените презентацию от 1 до 5 баллов!
- Тип файла:ppt / pptx (powerpoint)
- Всего слайдов:36 слайдов
- Для класса:1,2,3,4,5,6,7,8,9,10,11
- Размер файла:613.14 kB
- Просмотров:56
- Скачиваний:1
- Автор:неизвестен
Слайды и текст к этой презентации:
№1 слайд
Содержание слайда: Few words about how to write [disputably] nice code
Kamill Gusmanov
№2 слайд
Содержание слайда: Packages
Package system - way of hierarchical organization of the project code
In Java packages map to file system.
Each file belonging to a package X.Y.Z:
Should be placed in a folder PROJECT/X/Y/Z
Should have explicit declaration package X.Y.Z;
№3 слайд
Содержание слайда: Package visibility
package ru.innopolis.bootcamp2;
public class PublicClass { }
package ru.innopolis.bootcamp2;
class DefaultClass { }
№4 слайд
Содержание слайда: Package naming conventions
A name for a Java package must be a sequence of one or more valid Java identifiers separated by dots (“.”)
package java.lang;
package java.io;
package java.awt;
package ru.innopolis.iis.mlkr;
Usually, the letters in the name of a package are all lowercase
If a package is to be widely distributed, it is a common convention to prefix its name with the reverse Internet domain name of the producing or distributing organization, with slashes substituted by dots.
№5 слайд
Содержание слайда: Packages in file system
№6 слайд
Содержание слайда: Build in packages
We build and run with respect of the package
One class
javac ru/innopolis/bootcamp2/BootCampSpecificClass.java
cd ru/innopolis/bootcamp2
javac BootCampSpecificClass.java
java ru/innopolis/bootcamp2/BootCampSpecificClass
java DefaultClass
All classes in package
javac ru/innopolis/bootcamp2/*.java
All classes recursively (build tree)
Ant, Maven
№7 слайд
Содержание слайда: Referencing the package
№8 слайд
Содержание слайда: Stating coding standards
Coding standards - usually internal corporate document helping to organize the code
Start from Java Code Conventions
Keep it simple (less than 20 rules)
Better if developed by the team
Be not too specific
Avoid bad standards
Evolve it over time
№9 слайд
Содержание слайда: Stating coding standards
№10 слайд
Содержание слайда: Common rules
Each Java source file (.java file) has the following structure:
Introductory comments
Declaration of package (if needed)
Import instruction (if needed)
Definition of classes and interfaces (in Java you can store single class* in a file)
№11 слайд
Содержание слайда: What is comment
Comment - is a piece of text that do not affect compilation
Single line:
// something will happen here
int x = 4; //TODO: implement calculation of x!
Multiple lines (inline):
obj.callSomeMethod(a /* very important param */, b, c);
/* this is
Very long
Multiline
Comment */
№12 слайд
Содержание слайда: Special comments
Use “//XXX” in a comment to flag something that is bogus but works
Use “//FIXME” to flag something that is bogus and broken
Use “//TODO” to flag something that should be implemented
№13 слайд
Содержание слайда: Special comments
№14 слайд
Содержание слайда: Introductory comment (javadoc)
/**
* @deprecated if you recommend not to use a class
* to preserve backward compatibility
*
* @see OtherClass
*
* @serial SERIAL_NUMBER
*
* @since WHICH.VERSION.OF.THE.PROJECT/LIBRARY
*
* @version 1.0.0.1
*
* @author Stanislav Protasov
*/
*Javadoc support html
№15 слайд
Содержание слайда: Introductory comment (javadoc)
№16 слайд
Содержание слайда: Introductory comment
/*
* @(#)Blah.java 1.82 99/03/18
*
* Copyright (c) 1994-1999 Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, California,
* 94303, U.S.A. All rights reserved.
*
* This software is the confidential and
* proprietary information of Sun Microsystems,
* Inc. ("Confidential Information"). You shall
* not disclose such Confidential Information and
* shall use it only in accordance with the terms
* of the license agreement you entered into
* with Sun.
*/
№17 слайд
Содержание слайда: Class/Interface arrangement
Instance variables
Constructors
Methods
№18 слайд
Содержание слайда: Class/Interface arrangement
№19 слайд
Содержание слайда: Naming conventions
Divided into
Conventions about how to give meaningful names
Conventions about how names must be written
All of the names in your program should convey information about the purpose of the item they refer
Use not abbreviations for your names (only if they are in common use in normal speech)
Use descriptively named variables
Avoid ambiguous words
№20 слайд
Содержание слайда: Class Names (same for interfaces)
Should be singular nouns, referring to the object they represent
First letter and each internal word of class or interface names is capitalized (UpperCamelCase)
Train, Event, Station
Do not put hierarchy information in class names, unless real-world names bear this information
EmployeePerson, SecretaryEmployeePerson
№21 слайд
Содержание слайда: Method names
Verbs or verbal forms in mixed cases
Starting with lower letter and each internal word should be capitalized (lowerCamelCase)
Methods returning a boolean usually named with verb phrases expressing the question
isRed()
Methods assigning boolean variable can be named with verb phrases beginning with "set"/"be"
beOff(), setStateOffline()
№22 слайд
Содержание слайда: Method names
Methods returning void should be named with imperative verbs describing what they must do
openDBLink()
Methods converting a value into another should be named with verb phrases starting with "as"/"to" and
denoting the converted type
asDecimal(), toString()
Other methods should describe what they return
previousSignal()
Accessor methods may report the variable’s name prefixed with “get” or “set”
№23 слайд
Содержание слайда: Variables
Variables should be named for the objects they represent
Usually named with a singular noun
If it represent a collection of objects, its name should be plural
The name should not include typing information
lowerCamelCase
One lowercase letter variable names are OK only for temporary variables, indexes, etc.
№24 слайд
Содержание слайда:
№25 слайд
Содержание слайда: Parameter and constant names
Name parameters in such a way that the method call is readable
public static double power(double base, double exponent) {
//
}
Use named constants and not literal values, wherever a specific value is needed
In order to differentiate the names of constants from the other names, constants are often completely capitalized and compound names are separated by an underscore
№26 слайд
Содержание слайда:
№27 слайд
Содержание слайда: Code readability conventions
These conventions are often very close to design guidelines, since code readability is obtained with cohesive classes and methods
Classes and methods focused on performing a single task
Methods must be short
In Java standard less than 10 statements
Every method performs just one task, and
Every full method must fit on one screen
№28 слайд
Содержание слайда: Formatting conventions
Very important to ease code readability and to make quicker code inspections
The specific code convention adopted is less important than sticking to the same convention throughout the code
NetBeans: Alt + Shift + F
Eclipse: Ctrl/Cmd + Shift + F
№29 слайд
Содержание слайда: Formatting conventions
One statement per line
Use indents to highlight structured programming constructs
Do not indent too much…do not waste horizontal space!
Do not indent too little…make the structure evident!
№30 слайд
Содержание слайда: Putting brackets
Open brace “{” appears at the end of the same line as the class, interface, or method declaration
Closing brace “}” starts a line by itself aligned with the opening statement, except null block “{}”
No space between a method name and the parenthesis “(” starting its parameter list
Methods are separated by a blank line
When a nested statements occur within blocks
Use the 4 spaces rule, in general
№31 слайд
Содержание слайда:
№32 слайд
Содержание слайда: Lines and wrapping
When an expression will not fit on a single line, break it according to these general principles:
Break after a comma.
Break before an operator.
Prefer higher-level breaks to lower-level breaks.
Align the new line with the beginning of the expression at the same level on the previous line.
If the above rules lead to confusing code or to code that's squished up against the right margin, just indent 8 spaces instead.
№33 слайд
Содержание слайда:
№34 слайд
Содержание слайда: Variables declaration
There should be usually only one declaration per line to promote comments of the variables
Variables should be initialized where they are declared…
Unless the value of the variable depends on some computations to be performed later
Declarations should be placed at the beginning of the outermost block where a variable is used
Avoid declarations in inner blocks of variables with the same name as variable in outer blocks
№35 слайд
Содержание слайда: Example of good style
http://www.docjar.net/html/api/java/util/Collections.java.html
№36 слайд
Содержание слайда: Extra task
Given a system of linear equations, solve it using Cramer’s rule reusing created code.
Скачать все slide презентации Few words about how to write disputably nice code одним архивом:
