From d4d2d2f5b636d62e7c448d68b27b11f639b2adfa Mon Sep 17 00:00:00 2001 From: Vladimir Eliezer Tokarev Date: Fri, 22 Jan 2016 06:10:13 -0800 Subject: [PATCH] Added The Wombat Code And Documentation This file describes the conventions of the wombat project --- Wombat Code And Documentation Conventions | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 Wombat Code And Documentation Conventions diff --git a/Wombat Code And Documentation Conventions b/Wombat Code And Documentation Conventions new file mode 100644 index 0000000..f26d866 --- /dev/null +++ b/Wombat Code And Documentation Conventions @@ -0,0 +1,10 @@ +This file describes Wombat Code & Documentation Conventions: + +Code Conventions: + * Code- The good old classic java code conventions + camelCase convention, constants should be capital letters with underscore etc... + +Documentation Conventions: + * Comments- The good old classic java code documentation, Block Comments (to describe + method/class/interface etc...) // comments too describe complex code + (only if the code block complicated)