حل وثيقة واجهة تورنا v1.29.4

يهدف حل مستندات واجهة torna إلى جعل إدارة مستندات الواجهة أكثر ملاءمة وأسرع. يستخدم Torna تعاون الفريق لإدارة مستندات الواجهة وصيانتها، ويدمج أشكالًا مختلفة من المستندات في الصيانة الموحدة.

يعوض Torna أوجه القصور في أدوات إنشاء المستندات التقليدية (مثل التباهي)، مما يؤدي إلى إثراء وتعزيز بعض الوظائف العملية مع الحفاظ على الوظائف الأصلية.

حل نقاط الضعف في إدارة المستندات

1. غير راضٍ عن طريقة عرض صفحة معاينة المستند وصفحة تصحيح الأخطاء

2. لا أحب التعليقات التوضيحية المتطفلة مثل التباهي.

3. أتمنى استخدام تعليقات javadoc لإنشاء المستندات وإجراء تصحيح أخطاء الواجهة.

4. نأمل أن يتم إدارة جميع مستندات واجهة المشروع الخاصة بالشركة بشكل موحد

5. آمل أن أقدم العديد من المستندات في المشروع للمتصلين الخارجيين لمشاهدتها

6. نأمل أن يتم إدارة تعداد القاموس في المشروع بشكل موحد

خطوات الاستخدام

الطريقة الأولى: قم بتنزيل الملف المضغوط وتشغيله محليًا

تحضير

بيئة جافا، الحد الأدنى من المتطلبات Java8

يتطلب MySQL الإصدار 5.6.5 والإصدارات الأحدث، راجع ما قبل 5.6.5: يدعم MySQL المنخفض

1. قم بتنزيل هذا وفك ضغط الملف المضغوط

2. قم باستيراد قاعدة البيانات وتنفيذ mysql.sql

3. افتح ملف التكوين application.properties وقم بتعديل تكوين اتصال قاعدة البيانات.

4. قم بتنفيذ shstartup.sh للبدء (يقوم Windows بتنفيذ ملفstartup.bat)

5. تفضل بزيارة: http://ip:7700

حساب تسجيل الدخول

اسم المستخدم: المشرف، كلمة المرور: 123456

6. الترقيات اللاحقة

لا توجد تعليمات خاصة، فقط قم بالكتابة فوق ملف torna.jar ومجلد dist، ثم أعد تشغيله

الطريقة الثانية: تشغيل عامل الإرساء

1. قم باستيراد قاعدة البيانات وتنفيذ mysql.sql

2. قم بتنزيل الصورة العامة

عامل ميناء سحب Tanghc2020/تورنا:1.18.1

3. قم بإنشاء ملف application.properties فارغ ضمن /etc/torna/ لتخزين التكوين وتنفيذ الأمر

mkdir /etc/torna && touch /etc/torna/application.properties

4. تحرير ملف التكوين

vim /etc/torna/application.properties

5. أدخل التكوين التالي

# منفذ الخادم server.port=7700# عنوان MySQL mysql.host=:3306# اسم قاعدة البيانات mysql.schema=torna# حساب قاعدة البيانات، تأكد من إمكانية تنفيذ عبارات DDL mysql.username=mysql.password= <كلمة المرور>

قم بتعديل عنوان وحساب MySQL المطابقين

6. تنفيذ أمر الإرساء

تشغيل عامل الميناء --اسم تورنا --restart=always -p 7700:7700 -e JAVA_OPTS="-server -Xms512m -Xmx512m" -v /etc/torna/application.properties:/torna/config/application.properties -d Tanghc2020/torna:1.18.1

7. قم بالوصول إلى http://ip:7700 باستخدام المتصفح. يتوافق عنوان IP مع عنوان IP الخاص بجهاز مضيف عامل الإرساء وعنوان IP الخاص بالحاوية غير التابعة لعامل الإرساء.

المجموعة الموصى بها

يحقق Smart-doc + Torna أتمتة عملية المستندات بأكملها

إذا كنت تستخدم لغة جافا، فمن المستحسن استخدام Smart-doc + Torna

يشكل Smart-doc + Torna حلاً رائدًا في مجال إنشاء المستندات وإدارتها. يتم استخدام Smart-doc لاستخراج كود مصدر Java والتعليقات لإنشاء مستندات API دون التطفل، ودفع المستندات تلقائيًا إلى منصة إدارة المستندات بواجهة Torna على مستوى المؤسسة. .

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

إذا كنت تستخدم لغة غير Java، فيمكنك استخدام صفحة النموذج لتحرير المحتوى أعلاه، وبعد الانتهاء، يمكنك أيضًا معاينة الواجهة وتصحيح أخطائها.