UpgradeSoftwareReviewFT < LHCb

LHCb Web>LHCbUpgrade>UpgradeSimulations>UpgradeSoftwareReviews>UpgradeSoftwareReviewFT (2012-06-13, PaulSzczypka) (raw view)

EditAttachPDF

---+ Principal Reviewer

[[mailto:Kurt.Rinnert@cern.ch][Kurt Rinnert]]

---+ Code Location

| *Package* | *Functionality* | *Maintainer* |
| !Det/FTDet | The detector element package. | Plamen Hopchev |
| !Event/FTEvent | Contains the FT event classes. | Eric Cogneras |
| !FT/FTDigitisation | Contains the digitisation algorithms. | Eric Cogneras |
| !FT/FTDAQ | The raw bank encoder/decoder. | Olivier Callot |

---+ Review Comments 

   * Adhere to LHCb conventions for class and variable names.
   * Containers should have names which are a plural of the contained objects, e.g. "FTStations" contain FTStation objects/pointers.
   * Using namespaces can make code difficult to read - suggested to use a namespace alias to make it clear where a method comes from.
   * Strip out obsolete code, example given was "less_Chan" (which also violates naming conventions).
   * Variable names should be representative, "aSomething" is sometimes not a good name, especially if dealing with multiple instances of similar objects.
   * Debug statements should be protected.



-- Main.PaulSzczypka - 30-May-2012

Attachments

Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
pdf	2012-06-12_FT_code_structure.pdf	r1	manage	397.5 K	2012-06-12 - 16:05	PaulSzczypka	Initial Review Code Structure
pdf	rinnert_ftreview_20120612.pdf	r1	manage	251.2 K	2012-06-12 - 16:06	PaulSzczypka	Initial Reviewer Critique

Topic revision: r9 - 2012-06-13 - PaulSzczypka

LHCb

Public webs

Welcome Guest

- Cern Search
- TWiki Search
- Google Search
LHCb All webs