Neptus Package
| Package | Description |
|---|---|
| pt.lsts.neptus.mc | |
| pt.lsts.neptus.mc.lauvconsole |
| Package | Description |
|---|---|
| pt.lsts.neptus.renderer2d | |
| pt.lsts.neptus.renderer2d.tiles | |
| pt.lsts.neptus.renderer3d |
| Package | Description |
|---|---|
| pt.lsts.neptus.loader | |
| pt.lsts.neptus.loader.helper |
| Package | Description |
|---|---|
| pt.lsts.neptus.plugins | |
| pt.lsts.neptus.plugins.controllers | |
| pt.lsts.neptus.plugins.update |
| Package | Description |
|---|---|
| pt.lsts.neptus.i18n |
| Package | Description |
|---|---|
| pt.lsts.neptus.test |
View the unit tests here.
This software is provided using a dual license. One commercial and for that contact lsts@fe.up.pt, and another using "European Union Public Licence - EUPL v.1.1 Usage" (see here to check the license or check the included LICENSE.md file).
For more information check Neptus web site.
Neptus is hosted using Git. You should learn to use the Git client (or any other available front-end), studying the advantages and limitations of the system before compromising any part of the repository. A good Git guide is available at http://git-scm.com/ or https://help.github.com/.
Neptus' Git repository is accessible at https://github.com/LSTS/neptus/.
Take the following point into consideration:
The language of choice for writing code and documentation is English and you should not use other languages. The prefer encoding to use is UTF-8.
Do not use "underhanded names" (ones that begin with an underscore). Also the use of underscore is must only be used for constants.
Class and enum names should be nouns, in mixed case with the first letter of each internal word capitalized (in case of enums they should end with the word "Enum", e.g., "StatusEnum"). Try to keep your class names simple and descriptive. Use whole words. Avoid acronyms and abbreviations, unless the abbreviation is much more widely used than the long form, such as UDP or TCP. (e.g. UDPSocket or UdpSocket).
Methods names should be verbs, in mixed case with the first letter lowercase and the first letter of each internal word capitalized. (e.g. dumpRegisters).
Variable names should be short yet meaningful, in mixed case with the first letter lowercase and the first letter of each internal word capitalized. In the case of constants All characters should be uppercase with underscores separating words (e.g. ICON_START). The choice of a variable name should be mnemonic, that is, designed to indicate to the casual observer the intent of its use. One-character variable names should be avoided except for temporary "throwaway" variables. Common names for temporary variables are i, j, k, m, and n for integers; c, d, and e for characters.
Each source file must start with the following preamble (by using Eclipse this will be added for you). The blank line after the comment box should be the package declaration.
/*
* Copyright (c) 2004-2020 Universidade do Porto - Faculdade de Engenharia
* Laboratório de Sistemas e Tecnologia Subaquática (LSTS)
* All rights reserved.
* Rua Dr. Roberto Frias s/n, sala I203, 4200-465 Porto, Portugal
*
* This file is part of Neptus, Command and Control Framework.
*
* Commercial Licence Usage
* Licencees holding valid commercial Neptus licences may use this file
* in accordance with the commercial licence agreement provided with the
* Software or, alternatively, in accordance with the terms contained in a
* written agreement between you and Universidade do Porto. For licensing
* terms, conditions, and further information contact lsts@fe.up.pt.
*
* European Union Public Licence - EUPL v.1.1 Usage
* Alternatively, this file may be used under the terms of the EUPL,
* Version 1.1 only (the "Licence"), appearing in the file LICENCE.md
* included in the packaging of this file. You may not use this work
* except in compliance with the Licence. Unless required by applicable
* law or agreed to in writing, software distributed under the Licence is
* distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF
* ANY KIND, either express or implied. See the Licence for the specific
* language governing permissions and limitations at
* https://www.lsts.pt/neptus/licence.
*
* For more information please see <http://www.lsts.pt/neptus>.
*
* Author: Paulo Dias
* 2010/05/19
*/
package pt.lsts.neptus.util;
You must document the class with author tag and with one author per line and an optional sentence describing his/her work in the file
In terms of methods order, the constructors must be the first ones, and a main if existence must be the last method.
The declaration of variables must be on top just before the constructors. If you have final variables (constants) these
should be put on top of the other ones, and if they are static they should precede the others.
It is encourage if you use images for icons, to declare them as static final.
Eclipse project has the Neptus Code Style and you can format your code by Ctrl+Shift+F on your class code.
You must use Neptus Code Style which is based on the Java Conventions for code formating with the following exceptions/enforcements.
Indentation should be spaces only with a tab size of 4 spaces.
Single line if statement (use it only if the next statement is onle line lenght):
if (if-condition) if-line; else if (else-if-condition) else-if-line; else else-line;
Multiline if statement:
if (condition) { if-block; } else { else-block; }
Single line while statement (use it only if the next statement is onle line lenght):
while (condition) while-line;
Multiline while statement:
while (condition) { while-block; }
Single line for statement (use it only if the next statement is onle line lenght):
for (initialization; stop-condition; increment) for-line;
Multiline for statement:
for (initialization; stop-condition; increment) { for-block; }
Single and multiline line do while statement:
do { do-while-line; } while (condition);
Try/catch statement:
try { try-block; } catch (variable) { catch-block; } finally { finally-block; }
Switch statement:
switch (variable) { case A: a-statement; break; case B: b-statement; break; default: default-statement; break; }
Required Software:
Optional Software:
Neptus uses Apache Ant as its building system.
Check the targets for ant:
ant -pDefault command to use to prepare the necessary files to run Neptus:
antCopyright © 2004-2020 FEUP-LSTS and Neptus developers. All Rights Reserved.