# JAVA Best Practices

This is how we work with Java at BEEVA.

![BEEVA](https://github.com/beeva/beeva-best-practices/blob/master/static/horizontal-beeva-logo.png "BEEVA")
![JAVA](static/java.png "JAVA")

## Index

* [Introduction](#java-introduction)
* [Choosing proper names inside our code](#choosing-proper-names-inside-our-code)
* [Function's design](#function's-design)
* [Comments and documentation](#comments-and-documentation)
* [Code styling and formatting](#code-styling-and-formatting)
* [Encapsulation](#encapsulation)
* [Exception handling](#exception-handling)
* [Log traces](#log-traces)
* [Code testing](#code-testing)
* [Hints about code optimization](#hints-about-code-optimization)
* [References](#references)

## Introduction
---

## Choosing proper names inside our code
---

## Function's design
---

## Comments and documentation
---

## Code styling and formatting
---

## Encapsulation
---

## Exception handling
---

## Log traces
---

## Code testing
---

## Hints about code optimization
---

## References

### General recommendations
### Java Enterprise Edition recommendations
---

* [Sample reference] (http://www.beeva.es) Sample reference description

___

[BEEVA](http://www.beeva.com) | 2015
# JAVA Best Practices

This is how we work with Java at BEEVA.

![BEEVA](https://github.com/beeva/beeva-best-practices/blob/master/static/horizontal-beeva-logo.png "BEEVA")
![JAVA](static/java.png "JAVA")

## Index

* [Introduction](#java-introduction)
* [Choosing proper names inside our code](#choosing-proper-names-inside-our-code)
* [Function's design](#function's-design)
* [Comments and documentation](#comments-and-documentation)
* [Code styling and formatting](#code-styling-and-formatting)
* [Encapsulation](#encapsulation)
* [Exception handling](#exception-handling)
* [Log traces](#log-traces)
* [Code testing](#code-testing)
* [Hints about code optimization](#hints-about-code-optimization)
* [References](#references)

## Introduction
---

## Choosing proper names inside our code
---

## Function's design
---

## Comments and documentation
---

## Code styling and formatting
---

## Encapsulation
---

## Exception handling
---

## Log traces
---

## Code testing
---

## Hints about code optimization
### General recommendations
### Java Enterprise Edition recommendations
---

## References
---

* [Sample reference] (http://www.beeva.es) Sample reference description

___

[BEEVA](http://www.beeva.com) | 2015
Correct the location of the sub-indexes
Correct the location of the sub-indexes
