Closed

javaassignement

MISCELLANEOUS

JAVA TOPICS

JAVADOC

Page 1

Algonquin Documentation Standards

File Header

The file comments must contain the following information:

• File name: [[login to view URL] ]

• Author: [ Student name, ID#]

• Course: CST8132 – OOP

• Assignment: [number]

• Date: [the date of the final version of the file]

• Professor: [place here the name of your lab professor]

• Purpose: [brief description of the contents]

• Class list: [include this only if there is more than one

class in the file]

Java Documentation Standards

Class Doc Comments

Each class definitions must have a Java doc

comment (starts with /** ends with */ )

containing the following information:

• [Brief description of the purpose of the class]

• @author [your name if you wrote the class]

• @version [version number]

• @see [package name or a class name used in

the class– for example, [login to view URL], [login to view URL]]

• @since [the version number of the Java

compiler which was used to compile the class]

Java Documentation Standards

Method Doc Comments

Each of the class method definitions must have a

Java doc comment containing at least the

• following information:

• [Brief description of the purpose of the method]

• @param [name description] – one per

parameter and only if there are parameters

• @return [ type description] – used only if there

is a return type different from void

Java Documentation Standards

Field Doc Comments

Each of the class fields (data members)

must have a Java doc comment, which

describes

• briefly the purpose of the field (variable). If

the field is final, the {@value} tag must be

used.

Java Documentation Standards

Implementation Conventions and Comments (non-javadoc)

• All local variables must be commented. The comment must explain

the use of the variable.

• All function segments must be commented (a segment is a

sequence of related statements (i.e. loops, switches, if-else ladders

and sequence of linear statements performing some distinctive

task.)

• Each important line of code must be commented. A student should

use their judgment to decide whether the line is important. Important

lines: testing some special conditions; complex calculations;

conversions and so on. Do not overly comment your programs – do

NOT comment every line of code.

• The coding style and the naming should follow the Java coding

conventions.

Generating JavaDoc documentation

• JavaDocs will only be generated based on comments within the /** */

frame.

From command line:

• After you have completed all your testing, and are ready to submit your

assignment, create a folder named Assign4. This will be your deployment

folder. Inside create a folder named docs.

• Copy all Assign4 related .java files into the docs folder. All your files must

have a package statement.

• Open a command (DOS) window, make the docs folder current, and run

the javadoc utility with the following options:

javadoc -author -version -private *.java

• If javadoc generates some warnings or errors related to the @see tags which are referring to the Java API classes, ignore them. Pay attention to all

other errors and warnings. Correct the errors and generate the

documentation again.

• Check the documentation for correctness and completeness. Correct and

generate again.

• Delete the .java files from the docs folder.

Generating JavaDoc documentation

• JavaDocs will only be generated based on comments within the /**

*/ frame.

Eclipse:

• To generate the documentation with Eclipse you have to use the

File>Export>Java>Javadoc option. The Javadoc command must

point to javadoc.exe. For example

C:\Program Files\Java\jdk1.8.0_20\bin\[login to view URL]

• You must also select the Private option of Create Javadoc for

members with visibility:

• Reference for JavaDoc:

[login to view URL]

WebAppendices/[login to view URL]

(you need to register to the site first…..)

Skills: Java, JavaFX, Javascript, PHP, Software Architecture

See more: Our style guideline is attached, and you need to use this to guide your design. It must be compatible and follow this document., . Our style guideline is attached, and you need to use this to guide your design. It must be compatible and follow this document, follow up email after submitting resume, java operators list, bitwise operator in java, increment and decrement operators in java, operator in java with example, relational operators in java, pre and post increment in java, unary operator java, conditional operators in java, java, object-oriented, follow up email after sending resume, follow up email after resume, follow up email after phone interview, follow up email after phone call, follow up email after interview sample, follow up email after interview, follow up email after application

About the Employer:
( 0 reviews ) Canada

Project ID: #16038531

26 freelancers are bidding on average $404 for this job

liangjongai

I am a full time developer and have high skills in java so I can complete this project. My price and time is negotiable. Let's discuss details via chat. I'll provide best service. Relevant Skills and Experience Java More

$555 CAD in 2 days
(373 Reviews)
7.9
NovaSofts

Hello Sir/ Ma’am We are a group of Software Engineers having 10+ years of experience. Expert in java, C, C++ , C#. Please check our profile for reference. Thank you Relevant Skills and Experience Java ----- 10+ years More

$250 CAD in 1 day
(347 Reviews)
7.5
$555 CAD in 10 days
(42 Reviews)
7.4
$526 CAD in 10 days
(291 Reviews)
7.1
prakash2813

Hi there, I am java developer. I have read the details from attached pdf of browser. This is an easy job for me. Message me, I would like to discuss further details over chat. Relevant Skills and Experience I have ove More

$500 CAD in 5 days
(122 Reviews)
6.4
AhmedLabib93

Hello I'm expert java developer with experience in object oriented, data structure, swing, javafx and more advanced concepts. I can help you to finish this project with great quality. Regards Relevant Skills and Exper More

$250 CAD in 3 days
(417 Reviews)
6.6
vladang

Hello sir/madam. I can make your java assignment as per requirements described in attached document. Relevant Skills and Experience Java programming experience over 10 years Proposed Milestones $250 CAD - full job C More

$250 CAD in 10 days
(155 Reviews)
6.4
usman1493

Hey A Java expert developer is here I have good advanced expertise in Java and Javafx I can write a Java assignment for you as per the requirements Feel Free to message me Regards Relevant Skills and Experience Java J More

$250 CAD in 0 days
(179 Reviews)
6.5
topithub

javaassignement Relevant Skills and Experience Java, JavaFX, Javascript, PHP, Software Architecture 7 years experience Proposed Milestones $500 CAD - task

$500 CAD in 10 days
(31 Reviews)
6.4
$300 CAD in 10 days
(39 Reviews)
6.1
shadabkhan92

Worked with Adobe in software development, and software architecture our core language was Java, Js, Relevant Skills and Experience We are team of developers with more than 7 years of experience, experts in Java, JS, More

$555 CAD in 10 days
(32 Reviews)
6.3
cijagani

Thanks for providing me opportunity to place bid over the project and communicate with you. Relevant Skills and Experience i have a lots of experience in PHP MVC,MySQL, Wordpress, Codeigniter, laravel and Web Designin More

$250 CAD in 5 days
(135 Reviews)
6.4
shingjin

Hello. After reviewing your post, I am very interested in that due to my experience. I’d like to be considered for your project position. Relevant Skills and Experience java Proposed Milestones $300 CAD - java e

$300 CAD in 5 days
(56 Reviews)
5.9
mayankinnovative

A proposal has not yet been provided

$250 CAD in 6 days
(79 Reviews)
4.5
ExperSolutions

hi we are expert in java coding and concept revising with a low level to advance and will teach you until you satisfy Relevant Skills and Experience java, oop Proposed Milestones $250 CAD - basic

$250 CAD in 10 days
(29 Reviews)
4.4
anuragiitk

I am an IITK graduate and I have 11 years of experience in software development. We are a team of rockstar engineers. [login to view URL] Relevant Skills and Experience We are java exp More

$555 CAD in 10 days
(26 Reviews)
5.7
$250 CAD in 2 days
(15 Reviews)
3.8
$555 CAD in 10 days
(11 Reviews)
3.9
amolupraity

I have more than 4 years of experience in Java programming and the task will be completed within the proposed deadline. Relevant Skills and Experience I have more than 4 years of experience in java programming. Propo More

$250 CAD in 5 days
(12 Reviews)
3.5
sparkmultiz

A proposal has not yet been provided

$611 CAD in 12 days
(5 Reviews)
3.3