แรงจูงใจ . เราไม่มีเครื่องมือดังกล่าวที่จะตรวจสอบแนวทางปฏิบัติของโครงการ OOP ของเราบอกว่าเราทำอะไรผิด
OOPCOP เป็นเครื่องมือการวิเคราะห์แบบคงที่และปลั๊กอิน Maven ที่จะช่วยให้คุณสร้างแบบจำลองวัตถุคลาสของคุณวิธีการอย่างถูกต้องโดยการปฏิเสธรหัส ที่ไม่สมบูรณ์แบบ ของคุณ สิ่งเหล่านี้เราไม่ยอมทน:
วิธีใช้ . สิ่งที่คุณต้องการคือสิ่งนี้ (รับเวอร์ชันล่าสุดที่นี่):
Maven:
< build >
< plugins >
< plugin >
< groupId >ru.l3r8y</ groupId >
< artifactId >oop-cop</ artifactId >
< version >0.2.8</ version >
< executions >
< execution >
< goals >
< goal >search</ goal >
</ goals >
</ execution >
</ executions >
</ plugin >
</ plugins >
</ build >หากคุณต้องการเรียกใช้ปลั๊กอินโดยตรง:
$ mvn ru.l3r8y:oop-cop:searchชั้นเรียนเหล่านี้ใช้ได้:
class Pet {
private final String name ;
public Pet ( final String n ) {
this . name = n ;
}
}คลาสนี้ไม่ถูกต้อง:
class Pet {
private String name ;
public Pet ( final String n ) {
this . name = n ;
}
public void setName ( final String name ) {
this . name = name ;
}
}อย่างไรก็ตามคุณสามารถระงับการตรวจสอบนี้ได้โดยเพิ่ม:
@ SupressWarnings ( "OOP.MutableStateCheck" )ตัวอย่างเหล่านี้ถูกต้อง:
class ParsedFile {
...
public String asText () {
...
}
}ในขณะนี้ไม่ถูกต้อง:
class FileParser {
...
public String parse () {
...
}
}อย่างไรก็ตามคุณสามารถระงับการตรวจสอบนี้ได้โดยเพิ่ม:
@ SupressWarnings ( "OOP.ErSuffixCheck" )tbd ..
tbd ..
tbd ..
ตัวอย่างนี้ใช้ได้:
class PgItem {
...
}ในขณะที่สิ่งนี้เสีย:
class AbstractDatabaseConnection {
...
}ในการกำหนดค่าความยาวที่สมเหตุสมผลสูงสุดให้พิจารณาโดยใช้พารามิเตอร์ต่อไปนี้:
< plugin >
< groupId >ru.l3r8y</ groupId >
< artifactId >oop-cop</ artifactId >
...
< configuration >
< maxClassNameLen >15</ maxClassNameLen >
<!-- default is 13 -->
</ configuration >
</ plugin > ที่เก็บส้อมทำการเปลี่ยนแปลงส่งคำขอดึงมาให้เรา เราจะตรวจสอบการเปลี่ยนแปลงของคุณและนำไปใช้กับสาขา master ในไม่ช้าหากพวกเขาไม่ละเมิดมาตรฐานคุณภาพของเรา เพื่อหลีกเลี่ยงความยุ่งยากก่อนที่จะส่งคำขอดึงของคุณมาให้เราโปรดเรียกใช้ Maven Build เต็ม:
$ mvn clean install -Pquliceคุณจะต้องมี Maven 3.8+ และ Java 8+