توليد وثائق html تلقائيا خلال بناء مع الرمال

Question

ما هي الخطوات هل أنا بحاجة إلى اتخاذ الحصول على وثائق HTML تلقائيا بناء طريق بناء خطوة في Visual Studio?لدي جميع التعليقات في المكان ، comments.xml الملف يتم إنشاء تثبيت الرمال.أريد فقط أن أعرف ماذا تضيف إلى ما بعد بناء هذه الخطوة من أجل إنشاء مستندات.

Answer 1

وقد تم إجراء بعض التغييرات منذ أن طرح هذا السؤال.الرمال لم يعد يتضمن SandcastleBuilderConsole.exe.بدلا من ذلك فإنه يستخدم القديم عادي MSBuild.exe.

دمج هذا مع visual studio هنا هو ما فعلته:

المكان هذا في رسالتك-بناء الحدث:

IF "$(ConfigurationName)"=="Release" Goto Exit

"$(SystemRoot)\microsoft.net\framework64\v4.0.30319\msbuild.exe" /p:CleanIntermediates=True /p:Configuration=Release "$(SolutionDir)ProjectName\doc\DocumentationProjectName.shfbproj"

:Exit

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

بضع ملاحظات:

• بلدي هو نظام 64 بت, إذا كان لك لا ثم استبدال framework64 مع framework في الطريق إلى msbuild.exe.

• بالمناسبة لدي إعداد وثيقة لكل مشروع في الحل بشكل فردي.إذا كان لديك "الرمال ملف المساعدة باني" ملف المشروع الذي يتضمن العديد من المشاريع معا ، ثم ربما كنت ترغب في التخلص من ProjectName\ ونقل doc في الحل الدليل.في هذه الحالة سوف تحتاج فقط إلى وضع Post-build الأوامر على المشروع الذي بنيت الماضي في الحل الخاص بك.إذا كان يمكنك وضعه في حدث بعد البناء لكل مشروع ثم سيتم إعادة بناء الوثائق لكل المشاريع التي يتم بناؤها.وغني عن القول, سوف تكون جالسا هناك فترة من الوقت.أنا شخصيا أفضل أن الوثيقة كل مشروع على حدة ، ولكن هذا مجرد لي.

تثبيت الرمال و "الرمال تساعد الملف منشئ".

إذا كنت لا تعرف كيفية الحصول على الرمال و "الرمال ملف المساعدة باني" الإعداد بشكل صحيح ، ثم اتبع الخطوات التالية:

1. تحميل وتثبيت الرمال من http://sandcastle.codeplex.com/ (إذا كان لديك نظام 64 بت, سوف تحتاج إلى إضافة متغير بيئة.تعليمات هنا.

2. تحميل وتثبيت "الرمال ملف المساعدة باني" من http://shfb.codeplex.com/ (تجاهل تحذيرات حول MSHelp2 إذا كنت تحصل على أي.لن تكون في حاجة إلى ذلك.)

3. وبمجرد الانتهاء من تلك المثبتة ثم استخدام "الرمال ملف المساعدة باني" إلى إنشاء وثائق المشروع.عندما يطلب منك مكان حفظ الملف وحفظه في مجلد الوثائق في الحل/المشروع.http://www.chevtek.com/Temp/NewProject.jpg

4. بعد إنشاء مشروع جديد سوف تحتاج إلى اختيار أي نوع من الوثائق التي تريد إنشاء.مترجمة ويندوز ملف مساعدة, موقع, أو كليهما.http://www.chevtek.com/Temp/DocumentationType.jpg

5. إذا قمت بحفظ SHFB مشروع الملف في الدليل حيث تريد الوثائق إلى أن تتولد ثم يمكنك تخطي هذه الخطوة.ولكن إذا كنت ترغب في إنشاء الوثائق توضع في أماكن أخرى إذا كنت في حاجة إلى ضبط مسار الإخراج.http://www.chevtek.com/Temp/OutputPath.jpg ملاحظة:شيء واحد أن نأخذ في الاعتبار حول مسار الإخراج (التي أحبطت لمدة ساعة) هو أنه عندما يكون لديك موقع فحص نوع من الوثائق ما تريد الكتابة فوق المحتوى في انتاجها المسار.ما نهمل أن أقول لكم أن SHFB عمدا تقييد بعض المجلدات من كونها جزءا من مسار الإخراج.سطح المكتب هو واحد من هذا المجلد.الإخراج الخاص بك المسار لا يمكن أن يكون على سطح المكتب ولا حتى مجلد فرعي من سطح المكتب.فإنه لا يمكن من المستندات سواء ، ولكن يمكن أن يكون فرعي من المستندات.إذا كنت تحصل على أخطاء عند بناء الوثائق الخاصة بك, حاول تغيير مسار الإخراج ومعرفة ما إذا كان هذا يصلح له.انظر http://shfb.codeplex.com/discussions/226668?ProjectName=shfb لمزيد من التفاصيل على هذا.

6. أخيرا, سوف تحتاج إلى إضافة مرجع إلى المشروع الذي تريد الوثيقة.إذا كنت تفعل المشاريع الفردية كما أفعل ، ثم لكل SHFB ملف مشروع إنشاء ، وسوف المرجعية المقابلة .الملف CSPROJ.إذا كان لديك واحدة SHFB المشروع الخاص بك بأكمله الحل ، ثم يمكنك أن تجد .SLN ملف الحل.(sandcastle يعمل أيضا إذا كنت المراجع المترجمة دلس لكن بما أنك دمج ذلك مع Visual Studio أجد أنه من المنطقي أن المرجعية المشروع/حل الملفات بدلا من ذلك.هذا قد يعني أيضا أنه حقا لا يهم المشروع الذي تفعله حدث بعد البناء على لأنه هو الرجوع إلى التعليمات البرمجية بدلا من دلس ، ولكن من الأفضل أن تكون آمنة ووضعها على آخر المشاريع التي بنيت) http://www.chevtek.com/Temp/AddSource.jpg

7. حفظ المشروع ثم يمكنك إغلاق "الرمال تساعد الملف منشئ".الآن كل شيء هو الإعداد.فقط تأكد من وضع مشروع توثيق الملف في المجلد المناسب أن أوامر دفعية نقطة في حدث بعد البناء.

اتمنى ان البرنامج التعليمي قصيرة تساعدك على الخروج!كان من الصعب جدا بالنسبة لي أن تجد أي لائقة الدروس تبين لي كيفية استخدام الرمال ، ناهيك عن كيفية دمجها مع visual studio.نأمل في المستقبل البحث جوجل سوف يحضر هذا السؤال.

Answer 2

وأوصي تثبيت القلعة الرملية مساعدة باني ملف من كود بلاكس .

ويمكنك تشغيل هذا من سطر الأوامر، على سبيل المثال من حدث بعد إنشاء. سطر الأوامر أبسط هو:

<install-path>\SandcastleBuilderConsole.exe ProjectName.shfb

والقلعة الرملية بطيئة جدا، لذلك أنا فقط تشغيله ليبني الإصدار. للقيام بذلك، إنشاء حدث بعد بناء مع شيء أمر كما يلي، الذي يمر اسم التكوين إلى ملف دفعي:

CALL "$(ProjectDir)PostBuild.cmd" $(ConfigurationName)

وبعد ذلك داخل الملف الدفعي يمكنك اختبار إذا كانت الوسيطة الأولى هي "الإصدار"، وإذا كان الأمر كذلك تشغيل SandcastleBuilderConsole.exe.

Answer 3

وهناك طريقة سهلة للقيام بذلك على النحو المقترح أعلاه تستخدم القلعة الرملية مساعدة باني ملف. كانت هناك بعض التغييرات التي أدخلت على عملية الإنشاء من سطر الأوامر ويمكن أن يبنى الآن هذه المشاريع مع MSbuild بدلا من SandcastleBuilderConsole.exe. ذلك كل ما عليك القيام به هو:

وMSbuild.exe ProjectName.shfb

Answer 4

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

لالاستخدام المنتظم، وأجد في الواقع من السهل فقط أن أشير العاكس في مجلد مع الملفات دلل و XML - IIRC، فإنه سيتم تحميل ملف xml (ق) كما يمكنك التنقل في جميع أنحاء

وبالاضافة الى انني دائما تقريبا وقد عاكس فتح على أي حال ...

[عدل] فحص، ونعم - تظهر تعليقات أكس في لوحة المجمع

Answer 5

وتثبيت هذه:

وNDoc: http://prdownloads.sourceforge.net/ndoc /NDoc-v1.3.1.msi؟download

ورشة تعليمات HTML: HTTP : //www.microsoft.com/downloads/details.aspx FamilyID = 00535334-c8a6-452f-9aa0-d597d16580cc وdisplaylang = أون

وبعد ذلك استخدام سطر الأوامر NDocConsole.exe لتوليد الوثائق في أي MSDN أو شكل CHM:

وc: \ PROGRA ~ 1 \ NDoc \ NDocConsole.exe MyCode.dll، MyCode.xml -Documenter = MSDN-CHM

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

و(PS لقد تم استخدام الإعداد فوق لبضع سنوات حتى الآن، وأنا سعيد جدا معها)