Software Development Project. Kazi Masudul Alam

Transcription

1 Software Development Project Kazi Masudul Alam

2 Course Objective Study Programming Best Practices Apply the knowledge to build a Small Software in Groups 7/10/2017 2

3 Programming Best Practices Code Formatting Comments Code Versioning System Object Oriented Design Design Pattern Architecture Pattern File/Folder Structure Documentation Project Management 7/10/2017 3

4 Code Formatting

5 Indentation Line Length Avoid lines longer than 80 characters, since they re not handled well by many terminals and tools. Wrapping Lines 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. 7/10/2017 5

6 Declarations Number Per Line One declaration per line is recommended since it encourages commenting. 7/10/2017 6

7 Placement Put declarations only at the beginning of blocks. (A block is any code surrounded by curly braces { and }.) Don t wait to declare variables until their first use; it can confuse the unwary programmer and hamper code portability within the scope. 7/10/2017 7

8 Initialization Try to initialize local variables where they re declared. The only reason not to initialize a variable where it s declared is if the initial value depends on some computation occurring first. Class and Interface Declarations 7/10/2017 8

9 Statements Simple Statements Each line should contain at most one statement. return Statements if, if-else, if-else-if-else Statements 7/10/2017 9

10 Naming Conventions Naming conventions make programs more understandable by making them easier to read. They can also give information about the function of the identifier for example, whether it s a constant, package, or class which can be helpful in understanding the code. 7/10/

11 7/10/

12 Comments

13 Inline Commenting This is perfect to explain possibly confusing functionality. 7/10/

14 Descriptive Blocks When you need to include a large explanation generally a single liner won t do the trick. There are pre-formatted comment templates used in about every area of programming. Descriptive blocks are most notably seen around functions and library files. Whenever you setup a new function it is good practice to add a descriptive block above the declaration. 7/10/

15 Group/Class Comments The very top area of your page should hold comments regarding the file itself. In this way you can quickly check where you re editing when working on multiple pages at the same time. 7/10/

16 Code Versioning System

17 Version Control Revision control is a kind of practice that tracks and provides control over changes to source code. Software developers use revision control software to maintain documentation of change of source code. It is common for multiple versions of the same software to be deployed in different sites and for the software's developers to be working simultaneously on updates. Bugs or features of the software are often only present in certain versions. It may be necessary to develop two versions of the software concurrently. One version has bugs fixed, but no new features (branch), while the other 7/10/2017 version is where new features are worked on (trunk). 17

18 7/10/

19 Object Oriented Design

20 S.O.L.I.D S.O.L.I.D is an acronym for the first five objectoriented design(ood) principles by Robert C. Martin, popularly known as Uncle Bob. S Single-responsiblity principle O Open-closed principle L Liskov substitution principle I Interface segregation principle D Dependency Inversion Principle 7/10/

21 Single-responsibility Principle A class should have one and only one reason to change, meaning that a class should have only one job. 7/10/

22 7/10/

23 Open-closed Principle Objects or entities should be open for extension, but closed for modification. 7/10/

24 7/10/

25 Liskov substitution principle All this is stating is that every subclass/derived class should be substitutable for their base/parent class. 7/10/

26 7/10/

27 Interface segregation principle A client should never be forced to implement an interface that it doesn t use or clients shouldn t be forced to depend on methods they do not use. 7/10/

28 7/10/

29 Dependency Inversion principle Entities must depend on abstractions not on concretions. It states that the high level module must not depend on the low level module, but they should depend on abstractions. 7/10/

30 Design Pattern

31 Design Pattern Design pattern is a general repeatable solution to a commonly occurring problem in software design. Design patterns can speed up the development process by providing tested, proven development paradigms. Effective software design requires considering issues that may not become visible until later in the implementation. Reusing design patterns helps to prevent subtle issues that can cause major problems and improves code readability for coders and architects familiar with the patterns. 7/10/

32 Creational Design Patterns Singleton Factory Factory Method Abstract Factory Builder Prototype Object Pool 7/10/

33 Singleton When to use Singleton pattern should be used when we must ensure that only one instance of a class is created and when the instance must be available through all the code. A special care should be taken in multi-threading environments when multiple threads must access the same resources through the same singleton object. Common Usage There are many common situations when singleton pattern is used: - Logger Classes - Configuration Classes - Accesing resources in shared mode - Other design patterns implemented as Singletons: Factories and Abstract Factories, Builder, Prototype 7/10/

34 Lazy Singleton 7/10/

35 Behavioral Design Patterns Chain of Responsibility Command Interpreter Iterator Mediator Observer Strategy Template Method 7/10/

36 Template Method Define the skeleton of an algorithm in an operation, deferring some steps to subclasses / Template Method lets subclasses redefine certain steps of an algorithm without letting them to change the algorithm's structure. 7/10/

37 public class Trip { public final void performtrip(){ docomingtransport(); dodaya(); dodayb(); dodayc(); doreturningtransport(); } public abstract void docomingtransport(); public abstract void dodaya(); public abstract void dodayb(); public abstract void dodayc(); public abstract void doreturningtransport(); } public class PackageA extends Trip { public void docomingtransport() { System.out.println("The turists are comming by air..."); } public void dodaya() { System.out.println("The turists are visiting the aquarium..."); } public void dodayb() { System.out.println("The turists are going to the beach..."); } public void dodayc() { System.out.println("The turists are going to mountains..."); } public void doreturningtransport() { System.out.println("The turists are going home by air..."); } } public class PackageB extends Trip { public void docomingtransport() { System.out.println("The turists are comming by train..."); } public void dodaya() { System.out.println("The turists are visiting the mountain..."); } public void dodayb() { System.out.println("The turists are going to the beach..."); } public void dodayc() { System.out.println("The turists are going to zoo..."); } public void doreturningtransport() { System.out.println("The turists are going home by train..."); } } 7/10/

38 Structural Design Patterns Adapter Bridge Composite Decorator Facade Flyweight Memento Proxy 7/10/

39 Facade Facade pattern hides the complexities of the system and provides an interface to the client using which the client can access the system. This type of design pattern comes under structural pattern as this pattern adds an interface to existing system to hide its complexities. 7/10/

40 Software Architecture Pattern

41 Architecture Pattern Model-View-Controller Architecture 3-Tier Architecture Service Oriented Architecture 7/10/

42 MVC Pattern MVC Pattern stands for Model-View-Controller Pattern. This pattern is used to separate application's concerns. Model - Model represents an object or JAVA POJO carrying data. It can also have logic to update controller if its data changes. View - View represents the visualization of the data that model contains. Controller - Controller acts on both model and view. It controls the data flow into model object and updates the view whenever data changes. It keeps view and model separate. 7/10/

43 7/10/

44 7/10/

45 3-Tier Architecture A 3-tier architecture separates its tiers from each other based on the complexity of the users and how they use the data present in the database. It is the most widely used architecture to design a DBMS. Database 7/10/

46 Service Oriented Architecture 7/10/

47 File/Folder Structure

48 7/10/

49 7/10/

50 Documentation

51 How to Write Software Documentation Writing Software Documentation for Technical Users Determine what information needs to be included. Decide how much of the documentation should be within the program code and how much should be separate from it. Choose the appropriate documentation tool. Writing Software Documentation for End Users Determine the business reasons for your documentation. Understand the audience you're writing the documentation for. Determine the appropriate format(s) for the documentation. Decide what form(s) the documentation should take. Choose the appropriate documentation tool. Tools JIRA 7/10/

52 Project Management

53 Tools (Trello) 7/10/

54 Build Small Software Form 3 Person Group. Find a library to build. Apply Test Driven Development Approach. Build a class and its relevant functions and along with its test cases. 7/10/