Skip to Content

Where can I find Java coding convention recommended by SAP Hybris?

Hi,

We wanted to set up the SAP hybris Java Code conventions for our project. Before SAP Hybris recommended the configuration below : https://wiki.hybris.com/display/generalArchive/hybris+Ee+Reference file : https://svn.hybris.de/misc/codeconventions/trunk/eesettings/hybrisJavaCodeconventions.xml

But the page is now archive. Does it mean that is not valuable anymore? For information all my previous Hybris project used hybrisJavaCodeconventions.xml.

Do you recommend another convention one today or we can continue to use the same ?

Is-it possible to have the same page hybris Ee Reference in the wiki/help for new project ?

Add a comment
10|10000 characters needed characters exceeded

Assigned Tags

Related questions

5 Answers

  • Best Answer
    Posted on Oct 27, 2018 at 11:45 AM

    There is no doubt that the recommendations mentioned in https://wiki.hybris.com/display/generalArchive/hybris+Ee+Reference are still valid. I can not comment anything about https://svn.hybris.de/misc/codeconventions/trunk/eesettings/hybrisJavaCodeconventions.xml as it is not accessible to me.

    IMHO, the best thing to follow is the code quality recommendations from hybrisALF documented at https://wiki.hybris.com/display/hybrisALF/Code+Quality and if you are going to setup sonar, you can download https://wiki.hybris.com/download/attachments/329566632/java-hybris-profile-public.xml?version=2&modificationDate=1501530560000&api=v2

    Please take a note of the following paragraph mentioned at https://wiki.hybris.com/display/hybrisALF/Measuring+Code+Quality+with+Sonar

    With the release of SAP Hybris Commerce 6.6 and going forward, there is now a SonarQube Quality Profile embedded in the platform download. The next step refers to its location. Even if you are not running SAP Hybris Commerce 6.6+, it is recommended that you at least download it to get access to this file.

    Add a comment
    10|10000 characters needed characters exceeded

  • Posted on Jun 06, 2019 at 11:22 PM

    Hi - please follow the section, Naming Conventions at https://www.oracle.com/technetwork/articles/java/code-convention-138726.html for JSP Names and Tag Names

    It is recommended to name the CSS and JS files in all lower case. Please check section, Use Lower Case File Names at https://www.w3schools.com/js/js_conventions.asp for more details.

    Add a comment
    10|10000 characters needed characters exceeded

    • As per the convention,

      • The name of your .jsp file should be petcoStocktAlertAction.jsp

      • The name of your .tag file should be categoryDefault.tag

      • The name of a .js file should be in all lower case e.g. imagegallery.js

      By the way, it looks like you missed to go through the sections in the links that I have mentioned :) because similar examples are also mentioned in those sections.

  • Posted on Oct 28, 2018 at 04:20 AM

    You seemed to be concerned about "hybrisJavaCodeconventions.xml" or source code formatting. The hybris Ee Reference you mentioned is already archived. So, I think you can take it as reference only. Take note that "hybrisJavaCodeconventions.xml" was designed / prepared at a time when Hybris still wasn't owned by SAP.

    The latest guide is under Development Tools > IDE in the ALF. "Same Source Formatting Configuration" simply says:

    In order to ensure a certain homogeneity of the source files and to facilitate the merging of source files, all project developers must strictly use the same formatting for all sources files. For teams using multiple IDEs it's important to keep the code style consistent as possible.

    In order to make sure the source formatting is consistent it is recommended to configure save actions.

    Further below, it tells you where you can customize these settings, and how you can export these settings so you can share it with the Team.

    From my understanding, the code formatting simply depends on the project or company, since each project may have their own styles. If you already have an existing style, you can reuse it. However, I think that other Coding Standards should still be followed / observed; these standards have nothing to do with code formatting.

    Add a comment
    10|10000 characters needed characters exceeded

  • Posted on Jun 06, 2019 at 10:51 PM

    Naming conventions for jsp and tag file implementations

    The names of the files jsp, tag and others like javascript and css must respect the camel notation in its file name?

    Help!

    Amy.

    Add a comment
    10|10000 characters needed characters exceeded

  • Posted on Jun 10, 2019 at 05:14 PM

    Very good! I like this answer...

    Add a comment
    10|10000 characters needed characters exceeded

Before answering

You should only submit an answer when you are proposing a solution to the poster's problem. If you want the poster to clarify the question or provide more information, please leave a comment instead, requesting additional details. When answering, please include specifics, such as step-by-step instructions, context for the solution, and links to useful resources. Also, please make sure that you answer complies with our Rules of Engagement.
You must be Logged in to submit an answer.

Up to 10 attachments (including images) can be used with a maximum of 1.0 MB each and 10.5 MB total.