Details

    • Type: Task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: Not version specific
    • Component/s: Code Standards
    • Security Level: Public (Public: Anyone can view)
    • Labels:
      None
    • KAI Review Status:
      Not Required
    • KTI Review Status:
      Not Required
    • Code Review Status:
      Not Required

      Description

      In QuickfinderViewHelperServiceImpl.java, in doCallback, all of the comments you added aren't needed. The code is self-documenting in that case. Comments are helpful for noting something that isn't obvious or perhaps why code was purposefully written in an anti-pattern. They're to help guide the next developer into understanding something meaningful that couldn't be derived from the code itself. Otherwise, they create clutter, adding "noise" to the code.

      Take this comment, for example:

      // retrieve the collection to manipulate
      List<PersonAccount> collection = qForm.getPeopleAccounts();

      We can tell that both from the name of the list and the name of the method. We're retrieving people accounts and placing them in a collection; by looking down a couple of lines, we'll see that we're using that collection for manipulation.

        Attachments

          Activity

          There are no comments yet on this issue.

            People

            • Assignee:
              nigupta Nisha Gupta (Inactive)
              Reporter:
              matthew.wuertz Matthew Wuertz (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 5 minutes
                5m