Score:-2

ฉันจะสร้างเอกสารสำหรับไซต์ของฉันโดยอัตโนมัติได้อย่างไร

ธง hk

ฉันกำลังทำงานบนไซต์ Drupal ที่ซับซ้อนซึ่งมีโมดูลแบบกำหนดเอง เอนทิตีแบบกำหนดเอง คลาสแบบกำหนดเอง มุมมองแบบกำหนดเอง เหตุการณ์แบบกำหนดเอง สมาชิกเหตุการณ์แบบกำหนดเอง แบบฟอร์มแบบกำหนดเอง ตัวควบคุมแบบกำหนดเอง ในระยะสั้นรหัสที่กำหนดเองจำนวนมาก

เป็นความท้าทายอย่างยิ่งในการพยายามอัปเดตเอกสารทางเทคนิคสำหรับระบบอยู่เสมอเมื่อเราเปลี่ยนแปลงแอปพลิเคชันอย่างต่อเนื่อง

มีวิธีสร้างเอกสารทางเทคนิคสำหรับไซต์โดยอัตโนมัติหรือไม่? ตัวอย่างเช่น.

โมดูลใช้สำหรับ x, y, z มุมมอง V ใช้สำหรับสิ่งต่าง ๆ มีการใช้บล็อกมุมมองในหน้าดังกล่าวและหน้าดังกล่าว ชนิดเนื้อหา C ใช้สำหรับ l, m, n และใช้ในมุมมอง V1, V2, V3

หากไม่อัตโนมัติทั้งหมด อย่างน้อยบางส่วน และมีกลไกในการเพิ่มรายการที่เหลือด้วยตนเองหรือไม่

แก้ไข: ขอบคุณสำหรับคำแนะนำเกี่ยวกับโมดูล API @cilefen ดูเหมือนจะเป็นวิธีที่ดีในการสร้างเอกสารเกี่ยวกับรหัสที่กำหนดเอง อย่างไรก็ตาม มีชิ้นส่วนที่เป็นส่วนหนึ่งของการกำหนดค่าเช่นกัน เช่น มุมมอง เลย์เอาต์ บล็อก เป็นต้น ซึ่งจะไม่ได้รับการบันทึกไว้ในโมดูล API

Score:1
ธง id

ใช้ โมดูล API เพื่อสร้างเอกสารจากรหัส Doxygen หรือ phpDocumentor อาจใช้ได้ผลสำหรับคุณเช่นกัน ทั้งนี้ขึ้นอยู่กับความต้องการของคุณ

Jaypan avatar
de flag
ฉันรองโมดูล API
hk flag
Thanks for the tip on the API module. That is an interesting option. How do you document views, layouts, content types and other items that are part of the configuration?
id flag
That is also the API module. Consider any *.api.php file in Drupal generates pages on the API site. We are now getting into opinion territory, but also https://www.mkdocs.org is simple and easy-to-use for ad-hoc documentation.

โพสต์คำตอบ

คนส่วนใหญ่ไม่เข้าใจว่าการถามคำถามมากมายจะปลดล็อกการเรียนรู้และปรับปรุงความสัมพันธ์ระหว่างบุคคล ตัวอย่างเช่น ในการศึกษาของ Alison แม้ว่าผู้คนจะจำได้อย่างแม่นยำว่ามีคำถามกี่ข้อที่ถูกถามในการสนทนา แต่พวกเขาไม่เข้าใจความเชื่อมโยงระหว่างคำถามและความชอบ จากการศึกษาทั้ง 4 เรื่องที่ผู้เข้าร่วมมีส่วนร่วมในการสนทนาด้วยตนเองหรืออ่านบันทึกการสนทนาของผู้อื่น ผู้คนมักไม่ตระหนักว่าการถามคำถามจะมีอิทธิพลหรือมีอิทธิพลต่อระดับมิตรภาพระหว่างผู้สนทนา