قطعة أثرية اصطلاح التسمية

Question

نحن نقوم مشروع كبير على أو إس جي أي وإضافة بعض المشاع وحدات.هناك بعض النقاش حول تسمية قطعة أثرية.

لذا احتمال واحد عند تسمية وحدة على سبيل المثال:

cmns-definitions (على التعاريف الشائعة) ، cmns-definition, لا يزال آخر هو cmns-def.هذه بعض التأثير أيضا على اسم الحزمة.الآن xx.xxx.xxx.xxx.xxx.commons.definitions, إذا تغيير cmns-def سيكون xx.xxx.xxx.xxx.xxx.commons.def.

داخل هذه الحزمة سوف تكون الطبقات مثل enums وغيرها من التعاريف المستخدمة في جميع أنحاء النظام.

أنا شخصيا الهزيل cmns-definitions منذ ليس هناك فقط 1 تعريف داخل الحزمة.أشخاص آخرين يشيرون إلى أن java.util لا يكون لديك فقط 1 فائدة هناك على سبيل المثال.لا يزال ، java.util هو اختصار بالنسبة لي.فإنه يمكن أن يعني جافا فائدة أو جافا المرافق.نفس الشيء يحدث مع commons-lang.

كيف اسم حزمة ؟ لماذا اخترت هذا الاسم ؟

1. cmns-definitions
2. cmns-definition
3. cmns-def

مكافأة السؤال:كيفية تسمية شيء مثل cmns-exceptions?كيف لي ان اسم ذلك.هل اسم cmns-xcpt?

ËDIT:

أنا رمي في أفكاري على هذا في الأمل في أن تكون إما تأكيد أو تناقض.إذا كنت يمكن أن يرجى.

حسب ما أعتقد ، على خلفية سبب اسم شيء هو أن تجعل من السهل أن نفهم ما هو في داخله.أو وفقا بيتر كرينز ، لتجعل من السهل أن نتذكر والقدرة على أتمتة العمليات عبر أنماط.وكلاهما الحجج المقنعة.

بلدي المنطق على النحو التالي من حيث نمط:

1) عندما substantivation يحدث ومن المعروف في هذه الصناعة ، متابعة على التسمية الخاصة بك.
على سبيل المثال:"ميزات" هو القضية على هذا.لدينا وحدة تسمى كمنس-الميزات.هل هذا يعني أن لدينا العديد من الميزات في هذه الوحدة ؟ لا.وهو ما يعني "الوحدة النمطية التي تنفذ "ملامح" الملف من أباتشي karaf".
"المشاع" هو substantivation من "المشترك" المتعارف عليها في هذه الصناعة.هذا لا يعني "العديد من القواسم المشتركة".وهو ما يعني "الرمز المشترك".

إذا رأيت تتمتع بشعبية كبيرة المشاع وحدة نمطية اسم أعلم أنه يحتوي على الرمز المشترك من أجل تتمتع بشعبية كبيرة (في هذه الحالة استخراج) ، على سبيل المثال.

2) عندما كمية من الطبقات داخل وحدة تتعاون لإعطاء متميزة "واحد فقط" معنى العموم ، استخدام صيغة المفرد إلى اسم.

الغالبية العظمى من وحدات يتم تضمين هنا.إن اسم شيء كمنس-الثبات-jpa, أعني أنه مهما الطبقات داخل في التعاون معا لتوفير jpa تنفيذ كمنس-الثبات-api.لا أتوقع 2 تطبيقات في داخله ، ولكن في الواقع لا يحصى من الطبقات التي تجعل معا تطبيق واحد.واضحة وضوح الشمس بالنسبة لي.لا ؟

3) عند مجموعة من الفئات يتم مع الغرض الوحيد من جمع فئات من تقارب, لكن الفصول لا تتعاون معا من أجل أي غرض استخدام صيغة الجمع.

هنا هو الحال على سبيل المثال من كمنس-التعاريف (enums المستخدمة من قبل النظام كله).

بدلا من ذلك باستخدام اختصار تلتف المشكلة مثلاكمنس مواطنه والتي يمكن أن تكون أيضا "تفسير الموسعة" من قبل الإنسان القارئ إلى كمنس-التعاريف.كثير من الناس استخدام أيضا "xxxx-util" معنى xxxx-المرافق العامة.

لا يزال خيار ثالث يمكن أن تستخدم حزمة الأشياء معا ، وذلك باستخدام الاسم نفسه يعني pluralization.كلمة "api" يتبادر إلى الذهن ، ولكن أي كلمة pluralizes شيئا مثل "حزمة".

دعم هذه الحالات (3) معروفة وحدات مثل المشاع-مجموعات (باستخدام صيغة الجمع) أو العموم dbcp (باستخدام اختصار) أو العموم لانغ (مرة أخرى اختصار) وأي شيء يستخدم api حزمة الطبقات معا عن طريق النسب.

من apache:
commons-مجموعات -> كثير قوية هياكل البيانات من شأنها تسريع التنمية من أهم تطبيقات جافا
العموم lang -> مجموعة من مساعد المرافق جافا.lang API
العموم dbcp -> حزمة من عدة بيانات الاتصال برك

Answer 1

'هو مجرد اسم ...'

أجد في حياتي المهنية الطويلة أن هذه مجرد أسماء يمكن أن يحدث فرقا هائلا في الإنتاجية.أنا لا أعتقد أنه يحدث فرقا إذا كنت تستخدم التعاريف, تعريف, أو def طالما أنك تتفق واستخدام أنماط في اسم سهلة التذكر و يمكن استخدامها لأتمتة العمليات.بناء على أساس نظام تسمية ثابت بلا حدود أسهل للعمل مع من بناء مع "لطيفة الإنسان عرض" أسماء المخصص وليس لديهم نمط ملموس.

إذا كنت تستخدم أنماط أسماء تميل إلى أن تصبح أقصر.الآن الناس الذين يعملون مع هذه الأسماء عادة تنفق الكثير من الوقت معهم.حتى القراءة لا يهم بقدر بهم ذاكري القيمة.اتضح أن المختصرات من 3 أو 4 أحرف هي قوية بشكل مفاجئ.واحدة من السبب هو أنها تعمل بشكل جيد هو أن هناك واحد فقط من الممكن اختصار بينما إذا ذهبت تعد هناك العديد من المرشحين.

على أي حال, معظم استيراد جزء هو الاتساق العام.حظا سعيدا.

Answer 2

definitions (أو def أو definition) هو اسم سيئ لأنه لا يملك أي الدلالي إلى القارئ.أنت في وجوه المنحى العالمي (أفترض) - حاول اتباع الاتفاقيات و المبادئ.وحدات في مخضرم يجب أن تكون سميت أكبر "التجريد" أنها تحتوي على."التعريف" هو شكل لا معنى.

سؤال مشابه:"وهو اسم فئة أفضل FileUtilities أو FileUtils".الجواب:لا شيء.

Answer 3

أساسا ما يمكنك القيام به مع التعاريف والاستثناءات هو توفير نوع من API الخاص بك وحدات أخرى.لذا أقترح أن تجمع التعاريف الاستثناءات إضافة واجهات ذلك.ثم فمن المنطقي أن ندعو كل كمنس-api.أنا عادة تفضل المفرد الأسماء كما هي أقصر ولكن أنت حر في أن تقرر كما هو مجرد اسم.