বৈজ্ঞানিক সফ্টওয়্যার নথিভুক্ত করার ভাল উপায়গুলি কী কী?

Question

অনেক সময়, যখন আমি অন্যান্য ব্যক্তিদের দ্বারা লিখিত বৈজ্ঞানিক কোডটি উত্তরাধিকারসূত্রে পেয়েছি বা सामना করেছি (বা মাঝে মাঝে এমনকি আমার নিজের কাজও), আমি লক্ষ্য করেছি যে ডকুমেন্টেশনগুলি খুব কম বা অস্তিত্বহীন। আমি ভাগ্যবান হলে আমি তথ্যবহুল মন্তব্য দেখতে পাই। আমি যদি খুব ভাগ্যবান হয় তবে ডক্সিজেন মন্তব্য এবং একটি ডক্সিফিলও রয়েছে যাতে আমার ফাংশন ইন্টারফেস এবং পরামর্শের জন্য কিছু ফর্ম্যাট এইচটিএমএল থাকতে পারে। যদি আমি অত্যন্ত ভাগ্যবান হন তবে একটি পিডিএফ ম্যানুয়াল রয়েছে এবং ডক্সিজেন এবং উত্স ফাইলের মন্তব্যের পাশাপাশি উদাহরণ রয়েছে এবং আমি উত্সাহী, কারণ এটি আমার জীবনকে অনেক সহজ করে তোলে।

সোর্স কোড ডকুমেন্টিংয়ে কোন তথ্য এবং সরঞ্জামগুলি কার্যকর? এই বিষয়টির জন্য, বৈজ্ঞানিক সফ্টওয়্যারটির ক্ষেত্রে, সেই উত্স কোডের সাথে থাকা ডেটা এবং ফলাফলগুলি নথিভুক্ত করতে কোন তথ্য এবং সরঞ্জামগুলি কার্যকর?

Comments

একটি সম্পর্কিত প্রোগ্রামার.এসই থ্রেড।

— জেএম

আর-তে, কোড নথিতে এবং ভিগনেটস (ম্যানুয়ালগুলি) লিখতে কেউ রোজিন (2) এবং / অথবা সোয়েভ ব্যবহার করতে পারে।

— রোমান Luštrik

একটি দুর্দান্ত উদাহরণ হ'ল ডিল.আইআই টিউটোরিয়াল যা আপনাকে কেবল সফটওয়্যারটি কীভাবে ব্যবহার করতে হয় তা শেখায় না তবে সীমাবদ্ধ উপাদানগুলি কীভাবে কাজ করে তাও শেখায়।

— ডেভিড কেচসন

ম্যাটলব কোডের ডকুমেন্টেশন আরও সহজ করার জন্য আমাকে এম 2 এইচটিএমএল প্রস্তাবিত হয়েছিল ।

— আর্টেম কাজনাচাচিভ

— org-

Answer 1

আমি মনে করি যে বৈজ্ঞানিক সফ্টওয়্যার সম্পর্কিত ডকুমেন্টেশনগুলি তিনটি বিভাগে বিভক্ত করা যেতে পারে, এগুলি সমস্তই সম্পূর্ণ বোঝার জন্য প্রয়োজনীয়। সবচেয়ে সহজ এবং সর্বাধিক সাধারণ হ'ল পৃথক পদ্ধতির ডকুমেন্টেশন। এর জন্য অনেকগুলি সিস্টেম রয়েছে। আপনি ডক্সিজেনের কথা উল্লেখ করেছেন , পাইথনের পাইডোক রয়েছে এবং পিইটিএসসিতে আমাদের নিজস্ব প্যাকেজ বপন রয়েছে যা নিম্নলিখিতগুলি উত্পন্ন করে ।

যাইহোক, কোনও সফ্টওয়্যার যা কোনও সাধারণ ইউটিলিটির বাইরে চলে যায়, আপনার একটি ম্যানুয়াল দরকার। এটি প্যাকেজের উদ্দেশ্য এবং এই উদ্দেশ্য অর্জনের জন্য কীভাবে এর বিভিন্ন কার্যকারিতা সংহত করে তার একটি উচ্চ-স্তরের ভিউ সরবরাহ করে। এটি প্রায়শই উদাহরণ ব্যবহারের মাধ্যমে একটি নতুন ব্যবহারকারীকে তাদের কোড গঠনে সহায়তা করে। পিইটিএসসি-তে আমরা ম্যানুয়ালটির জন্য কেবল ল্যাটেক্স ব্যবহার করি তবে পাইক্লা প্যাকেজ স্পিনক্স ফ্রেমওয়ার্ক ব্যবহার করে যা আমি খুব মুগ্ধ হয়েছি। একটি জিনিস যা আমরা বপন প্যাকেজটিতে প্রয়োগ করেছি যা আমি খুব দরকারী বলে মনে করি উদাহরণ কোড এবং ফাংশন ডকুমেন্টেশনের মধ্যে লিঙ্ক। উদাহরণস্বরূপ, এই উদাহরণব্রাতু সমীকরণ সমাধান করে। আপনি যে কোনও পছন্দসই টাইপ বা ফাংশন কলের লিঙ্কগুলি কীভাবে অনুসরণ করতে পারেন এবং নিম্ন-স্তরের ডকুমেন্টেশনে পৌঁছাতে পারেন এবং সেই পৃষ্ঠাগুলি কীভাবে উদাহরণগুলি ব্যবহার করে উদাহরণগুলিতে লিঙ্ক করে তা লক্ষ্য করুন। এইভাবে আমি নতুন কার্যকারিতা সম্পর্কে শিখি যা প্রকল্পের অন্যান্য লোকেরা অবদান রাখে।

আমার মনে হয় ডকুমেন্টেশনের প্রায়শই অবহেলিত অংশ হ'ল ডেভেলপার ডকুমেন্টেশন। কোনও কোডিং-স্টাইলের দস্তাবেজ প্রকাশ করা অস্বাভাবিক কিছু নয় এবং সংগ্রহশালাটির সাথে ইন্টারঅ্যাক্ট করার জন্য নির্দেশাবলী। যাইহোক, প্রয়োগের আগে যে নকশার সিদ্ধান্ত নিয়েছে তা ব্যাখ্যা করা খুব বিরল। এই সিদ্ধান্তগুলি সর্বদা ট্রেড অফগুলিতে জড়িত থাকে এবং হার্ডওয়্যার এবং অ্যালগরিদমের ক্ষেত্রে পরিস্থিতি সময়ের সাথে সাথে অগত্যা পরিবর্তিত হবে। ট্রেড অফগুলি পর্যালোচনা করা এবং নির্দিষ্ট নকশার সিদ্ধান্তের জন্য যৌক্তিক আলোচনা ছাড়াই পরবর্তীতে প্রোগ্রামাররা পুরো প্রক্রিয়াটি তাদের নিজস্বভাবে পুনরায় তৈরি করার জন্য ছেড়ে যায়। আমি মনে করি এটি সফল বজায় রাখা এবং পুরানো কোডগুলির উন্নতি করার ক্ষেত্রে একটি প্রধান প্রতিবন্ধক যখন মূল বিকাশকারীরা আর দায়িত্বে থাকেন না।

Comments

স্পিনিক্সের জন্য +1! নোট করুন যে এতে অটোডোক অন্তর্ভুক্ত রয়েছে , যা আমি পাইডোকের চেয়ে অনেক উন্নত।

— ডেভিড কেচসন

ইন্টারফেস / ব্যবহারকারী / বিকাশকারী ডকুমেন্টেশনে বিচ্ছিন্নকরণের জন্য +1।

— ফ্লোরিয়ান ব্রুকার

Answer 2

ইন-কোড ডকুমেন্টেশন

সর্বাধিক গুরুত্বপূর্ণ বিষয়টি হল আপনার নির্বাচিত বিকাশের পরিবেশে ডকুমেন্টেশন সুবিধাগুলি ব্যবহার করা, সুতরাং এর অর্থ পাইথনের জন্য পাইডোক , জাভাতে জাভাদোক বা সি # তে এক্সএমএল মন্তব্য । এগুলি কোড লেখার সাথে সাথে একই সাথে ডকুমেন্টেশন লিখতে সহজ করে তোলে।

আপনি যদি পরে ফিরে এসে জিনিসপত্রগুলি ডকুমেন্ট করার উপর নির্ভর করেন তবে আপনি এটির কাছাকাছি নাও যেতে পারেন, তবে কোডটি লেখার সময় আপনি যদি এটি করেন তবে কী কী নথিভুক্ত করা দরকার তা আপনার মনে তাজা হয়ে উঠবে। যদি এক্সএমএল ডকুমেন্টেশন প্রকৃত কোডের সাথে অসম্পূর্ণ বা অসম্পূর্ণ থাকে তবে সি # তেও একটি সংকলন সতর্কতা জারি করার বিকল্প রয়েছে।

ডকুমেন্টেশন হিসাবে পরীক্ষা

আরেকটি গুরুত্বপূর্ণ বিষয় হ'ল ভাল সংহতকরণ এবং ইউনিট পরীক্ষা করা।

প্রায়শই ডকুমেন্টেশন ক্লাস এবং পদ্ধতিগুলি বিচ্ছিন্নতার ক্ষেত্রে কীভাবে মনোনিবেশ করে সেগুলি কীভাবে আপনার সমস্যা সমাধানের জন্য একসাথে ব্যবহৃত হয় তা এড়িয়ে যায়। পরীক্ষাগুলি এগুলি একে অপরের সাথে কীভাবে ইন্টারঅ্যাক্ট করে তা দেখিয়ে প্রায়শই প্রসঙ্গে ফেলে।

একইভাবে, ইউনিট-পরীক্ষাগুলি প্রায়শই বাহ্যিক নির্ভরতাগুলি সুস্পষ্টভাবে নির্দেশ করে যার মাধ্যমে জিনিসগুলি মক এড আউট করা দরকার।

আমি আরও দেখতে পেয়েছি যে টেস্ট-চালিত বিকাশ ব্যবহার করে আমি এমন সফ্টওয়্যার লিখি যা ব্যবহার করা সহজ, কারণ আমি এটি গো শব্দটি থেকে ব্যবহার করছি। একটি ভাল পরীক্ষার কাঠামোর সাথে, কোডটি পরীক্ষা করা সহজ করে দেওয়া এবং এটি ব্যবহার করা সহজ করে তোলে প্রায়শই একই জিনিস।

উচ্চ স্তরের ডকুমেন্টেশন

অবশেষে সিস্টেম স্তর এবং আর্কিটেকচারাল ডকুমেন্টেশন সম্পর্কে কী করা উচিত। অনেকে উইকিতে এই জাতীয় ডকুমেন্টেশন লেখার বা ওয়ার্ড বা অন্যান্য ওয়ার্ড প্রসেসর ব্যবহারের পক্ষে পরামর্শ দিতেন, তবে আমার কাছে এই জাতীয় ডকুমেন্টেশনের জন্য সেরা জায়গাটি কোডের পাশাপাশি একটি সাধারণ টেক্সট ফর্ম্যাটে যা সংস্করণ নিয়ন্ত্রণ ব্যবস্থা বান্ধব।

ইন-কোড ডকুমেন্টেশনের মতোই, আপনি যদি নিজের কোড সংগ্রহস্থলে আপনার উচ্চ স্তরের ডকুমেন্টেশনগুলি সংরক্ষণ করেন তবে আপনি এটি আপ টু ডেট রাখার সম্ভাবনা বেশি। আপনি এই সুবিধাটি পাবেন যে আপনি যখন কোডটির XY সংস্করণটি বের করেন, আপনি ডকুমেন্টেশনের XY সংস্করণও পান। এছাড়াও, আপনি যদি ভিসিএস বান্ধব ফর্ম্যাট ব্যবহার করেন তবে এর অর্থ হল আপনার কোডের মতো আপনার ডকুমেন্টেশনগুলিকে শাখা করা, আলাদা করা এবং মার্জ করা সহজ।

আমি বেশ মত reStructuredText (প্রথম) , যেমন ব্যবহার করে এটি থেকে উভয় HTML পৃষ্ঠা এবং PDF ডকুমেন্ট তৈরী করা সহজ স্পিংক্স , এবং তুলনায় অনেক বন্ধুত্বপূর্ণ হয় ক্ষীর , এখনো এখনও অন্তর্ভুক্ত করতে পারে লেটেক্ গণিত এক্সপ্রেশন যখন আপনি তাদের প্রয়োজন।

Comments

কোডের জন্য ডকুমেন্টেশন সমর্থন করার জন্য নথি লেখার জন্য আমি Lyx( lyx.org ) এ নির্দেশ করতে চাই LaTeX।

— j72

আমি অতীতে লিক্স ব্যবহার করেছি, তবে আমি যে জিনিসটি পছন্দ rstকরি তা হ'ল আমি এটি একটি সাধারণ পাঠ্য সম্পাদক এ লিখতে পারি (একই আইডিতে আমি কোডটি লেখার জন্য ব্যবহার করি) এবং এখনও চূড়ান্ত নিশ্চিত হতে পারি যে চূড়ান্ত নথিটি কী দেখবে আমি জানি মত। এছাড়াও ফর্ম্যাটিং সম্মেলনগুলি এটি খুব ভিসিএস বন্ধুত্বপূর্ণ করে তোলে যা আমার কাছে গুরুত্বপূর্ণ to

— মার্ক বুথ

Answer 3

ফাহিম প্রায় প্রতিটি পয়েন্টেই আপত্তি নেব । বিশেষ করে:

1 / "আমি মনে করি যে বৈজ্ঞানিক বিকাশকারীরা তাদের সফ্টওয়্যার ডকুমেন্ট করার জন্য প্রচুর সময় ব্যয় করবেন বলে আশা করা অবাস্তব"। এটি একটি ব্যর্থ প্রকল্পের জন্য একটি প্রেসক্রিপশন যা শীঘ্রই কেউই ব্যবহার করতে সক্ষম হবে না যার প্রাথমিক বিকাশকারীদের অ্যাক্সেস নেই। এটি যুক্তিসঙ্গত কারণেই যে বড় বৈজ্ঞানিক কম্পিউটিং লাইব্রেরিগুলিতে (যেমন পিইটিএসসি, বা ডিল। আইআই) এর বিস্তৃত ডকুমেন্টেশন রয়েছে যা 1,000s বা তারও বেশি পৃষ্ঠাতে চলে। আপনার কাছে বিস্তৃত ডকুমেন্টেশন না থাকলে আপনার একটি বৃহত্তর ব্যবহারকারী সম্প্রদায় থাকতে পারে না। তবে আমি সম্মত হব, উদাহরণস্বরূপ কোডগুলি একক ধারণার উপর সহজ এবং ফোকাস করা দরকার।

2 / "লেখকদের উপযুক্ত হলে প্রকাশনার জন্য একটি কাগজ লেখার কথা বিবেচনা করা উচিত"। এটি প্রায়শই অনুশীলনে সম্ভব হয় না। কেউ ধারণা এবং অ্যালগরিদমগুলিতে কাগজপত্র লিখতে পারেন তবে ইন্টারফেস এবং অন্যান্য নকশার সিদ্ধান্তে নয়। এ জাতীয় কাগজপত্রের পাঠকগণ বাস্তবায়ন এটি কী করে তা একটি ধারণা পাবেন; বাস্তবায়নের ব্যবহারকারীদের কী ফাংশনগুলি কল করতে হবে, আর্গুমেন্টগুলি কী বোঝাতে হবে ইত্যাদি জানতে হবে a একজন ব্যবহারকারী হিসাবে, বেশিরভাগ সময় প্রাক্তনকে ছাড়া বাঁচতে পারে এবং কেবল একটি লাইব্রেরিকে একটি কালো বাক্স হিসাবে বিবেচনা করতে পারে, তবে এটি ছাড়া কিছুই করা যায় না ইন্টারফেস তথ্য।

Comments

স্বাগতম, ওল্ফগ্যাং; আমি মনে করি আপনি এই প্রশ্নের উত্তর দেওয়ার জন্য সঠিক ব্যক্তি, তবে আমার একটি পরামর্শ আছে: আপনি এখানে যা লিখেছেন তা সম্ভবত প্রশ্নের উত্তর না দিয়ে ফাহিমের উত্তর সম্পর্কে একটি মন্তব্য হওয়া উচিত।

— ডেভিড কেচসন

আমি এখন দেখতে পাচ্ছি। আমি মনে করি এটি কীভাবে কাজ করে সে সময় আমি বুঝতে পারি নি।

— ওল্ফগ্যাং ব্যাঙ্গার্থ

@ ওল্ফগ্যাংবাংয়ের্থ: আপনার মন্তব্যের জন্য ধন্যবাদ, যা আমি দেখতে পাইনি বলে আমাকে জানানো হয়নি। আমি মনে করি ফাহিমের সামনে কোনও @ এটি করতে পারতেন তবে আমার কাছে ভাল রেফারেন্স নেই। আমি আমার মন্তব্যে আপনার মন্তব্যগুলিকে সম্বোধন করার চেষ্টা করব - একটি মন্তব্যে পর্যাপ্ত জায়গা নেই।

— ফাহিম মিঠা 10'12

@ ফাহিমমিঠা: আপনি কি উত্তর লিখেছেন? একটি প্রশ্নের নতুন উত্তরের সমস্যাটি হ'ল তাদের পক্ষে কতগুলি আপ / ডাউনভিট পাওয়া যায় তার উপর ভিত্তি করে তাদের পুনঃ-অর্ডার করা হয় যেখানে মন্তব্যগুলি রৈখিক থাকে ...

— ওল্ফগ্যাং ব্যাঙ্গার্থ

@ ওল্ফগ্যাংবাংয়ের্থ - এটি ঠিক এই কারণেই যে কোনও উত্তরের যথাযথ উল্লেখ করা ভাল অনুশীলন হয় তবে আপনি এটি উল্লেখ করেন। এটি করা খুব দ্রুত এবং সহজ, কেবল উত্তরে যান, লিঙ্কটি ক্লিক করুন, তারপরে সংক্ষিপ্ত লিঙ্কটি অনুলিপি করুন, আপনার উত্তরটি যান, আপনি একটি লিঙ্ক তৈরি করতে চান এমন পাঠ্যটি নির্বাচন করুন (যেমনটি আমি আপনার জন্য করেছি), হাইপারলিংক ক্লিক করুন লিঙ্কে বোতাম এবং পেস্ট করুন। তারপরে যে কেউ আপনার উত্তরটির চেয়ে বেশি বা কম ভোট পেয়েছে কিনা তাড়াতাড়ি আপনি যে উত্তরটি উল্লেখ করছেন তার কাছে দ্রুত যেতে পারেন।

— মার্ক বুথ

Answer 4

এটা একটা ভালো প্রশ্ন। প্রথম অনুমানের জন্য, কোডটির স্ব-দস্তাবেজ হওয়ার চেষ্টা করা উচিত। সুতরাং, উদাহরণস্বরূপ, যদি সফ্টওয়্যার কমান্ড লাইন হয়, তাহলে আপনি কি করতে সক্ষম হওয়া উচিত executable --helpবা executable -hবা এমনকি executable(এক্সিকিউটেবল কোন যুক্তি দিয়ে কিছুই না হলে), এবং একটি সংক্ষিপ্ত ব্যবহার করা বার্তা ফেরত পাঠায় না।

দ্বিতীয়ত, আমি মনে করি যে বৈজ্ঞানিক বিকাশকারীরা তাদের সফ্টওয়্যার ডকুমেন্ট করার জন্য প্রচুর সময় ব্যয় করবেন বলে আশা করা অবাস্তব নয়, তাই আমি এটিকে সহজ রাখার পরামর্শ দিই। মৌলিক পদ্ধতি এবং বিকল্পগুলির সাথে একটি স্বল্প পাঠ্য ম্যানুয়াল এবং এনোটেটেড কাজ এবং পরীক্ষিতব্যবহারের উদাহরণগুলি, সহজ থেকে আরও জটিলতে স্নাতক (ব্যবহারের উদাহরণগুলি অত্যন্ত গুরুত্বপূর্ণ এবং প্রায়শই অবহেলিত) বেশিরভাগ বৈজ্ঞানিক সফ্টওয়্যার অফারের চেয়ে অনেক ভাল এবং বেশ কিছু। আমি ব্যবহারের উদাহরণগুলি সম্পর্কে একটি পোষা প্রাণীর যোগ করতে চাই। সরল অর্থ সরল। এর অর্থ আপনি যদি কোনও পদ্ধতি চিত্রিত করার চেষ্টা করছেন তবে আপনি দশটি বহিরাগত ধারণা বা পাঠককে বিভ্রান্ত করার পদ্ধতিতে যুক্ত করবেন না। এটিকে সহজ রাখুন এবং এ্যানোটেট করুন যাতে পাঠক জানেন যে উদাহরণটি কী করবে। আমি ম্যানুয়াল ব্যবহারের উদাহরণগুলি কোনওভাবে টেস্ট স্যুটে বেঁধে রাখার পরামর্শ দেব যাতে কোড পরিবর্তন করা হয় তখন তারা কাজ চালিয়ে যায়। আমি কীভাবে এটি একটি সুন্দর উপায়ে করব তা আসলে জানি না, তাই দয়া করে আমাকে শিক্ষিত করুন। বিকাশকারীরা যদি আরও অভিনবতা পেতে চান তবে নিশ্চিত হয়ে নিন যে তারা দুর্দান্ত মার্কআপ ল্যাঙ্গুয়েজ এবং আরও কিছু কিছু ব্যবহার করতে পারে, ম্যান পেজ এবং আরও কিছু যুক্ত করতে পারে।

তৃতীয়ত, উপযুক্ত হলে লেখকদের প্রকাশনার জন্য একটি কাগজ লেখার বিষয়টি বিবেচনা করা উচিত। এটি সাধারণত নকশার সিদ্ধান্তগুলিকে সম্বোধন করে এবং ম্যানুয়ালের চেয়ে সফ্টওয়্যারটিতে আরও উচ্চ স্তরের দৃষ্টিভঙ্গি দেয় বা এটি করা যায় বলে আশা করা যায়। এটি @ ম্যাট যে কথা বলেছিল সেই নকশার সিদ্ধান্তগুলির ডকুমেন্টেশনটিকে সম্বোধন করবে।

অবশ্যই, সকলের সবচেয়ে গুরুত্বপূর্ণ ডকুমেন্টেশন হ'ল কোড নিজেই, যা প্রয়োজনীয় হিসাবে মন্তব্য করা উচিত। এই কোডটি নিখরচায় সফ্টওয়্যার হিসাবে ধরে নিয়েছে। যদি এটি না হয় তবে এটি বৈজ্ঞানিক সফ্টওয়্যার হিসাবে যথেষ্ট পরিমাণে কার্যকর (আপনি কী এমন কোনও ব্ল্যাক বক্স ব্যবহার করতে চান যেখানে পদ্ধতিগুলি কীভাবে প্রয়োগ করা যায় তা আপনি দেখতে পাচ্ছেন না?) এবং আমি এটি ব্যবহার না করব।

Answer 5

কীভাবে ডেটা এবং ফলাফল ডকুমেন্ট করবেন সে সম্পর্কে আপনার প্রশ্নের সমাধানের জন্য, আমি পাইথনের ডক্টেস্ট মডিউলের মতো কিছু প্রস্তাব দেব । এটি আপনাকে এমনভাবে টিউটোরিয়াল বা পরীক্ষা লিখতে দেয় যা স্বয়ংক্রিয়ভাবে যাচাই করা যায়।

Answer 6

আপনি যদি শিক্ষিত প্রোগ্রামিংয়ে আগ্রহী হন, org-babel এ একবার দেখুন । এটি ইমাসে অরগ-মোডের অংশ এবং এটি আপনাকে ডকুমেন্টেশনের জন্য রফতানির বিকল্পগুলির (ল্যাটেক্স, পিডিএফ, এইচটিএমএল, ওডিটি) বিস্তৃত অ্যারে দেয়। ইমাক্স বাফারের অভ্যন্তরে চিত্রগুলি প্রদর্শন করতে পারে এবং আপনাকে ল্যাটেক্স সিনট্যাক্সে গাণিতিক সমীকরণ লিখতে দেয় যাতে আপনার নিজেকে সরল পাঠ্য ডকুমেন্টেশনে সীমাবদ্ধ করতে না হয়।

Comments

Org- মোডের একটি প্রাসঙ্গিক বৈশিষ্ট্যটি হ'ল এটি লেখায় নির্বিঘ্নে সি, এসকিউএল, ব্যাশ, আর, পাইথন এবং অন্যান্য অনেকগুলি ভাষা কার্যকর করে।

— ডেভিড লেবাউর

Answer 7

আপনার উত্স কোড থেকে স্বয়ংক্রিয়ভাবে প্রাপ্ত ডকুমেন্টেশনটি আপ-টু-ডেট অর্থাৎ সঠিক ডকুমেন্টেশন থাকার ক্ষেত্রে একটি প্রয়োজনীয় উপাদান। আমি গণনা করতে পারবে না কতবার আমি ডকুমেন্টেশন যে দেখা করেছি বছর ডকুমেন্টেশন প্রতি ডেভেলপার উদাসীনতা কারণে সোর্স কোড পিছনে। সহজ সমাধান হ'ল প্রোগ্রামারদের জন্য একই সময়ে নতুন কোডের সাথে একই সাথে ডকুমেন্টেশন লিখতে সহজ করে দেওয়া কিছু উত্তরোত্তর প্রচেষ্টা যেমন অনিবার্যভাবে আরও গৌরবময় কার্যকলাপের পক্ষে অগ্রাধিকারযোগ্য হবে।

যদি জোর করে বেছে নিতে হয়, তবে আমি বরং বিশদ এবং নির্ভুল (উদাহরণস্বরূপ বর্তমান) সোর্স কোড মন্তব্য করব তবে ভুল তথ্যে পূর্ণ যুগে যুগে থাকা ম্যানুয়াল ম্যানুয়াল ছাড়া কোনও ব্যবহারকারী ম্যানুয়াল নেই ।

Answer 8

পাইথনে pep8 এবং pep257 সরঞ্জাম রয়েছে যা অনুপস্থিত বা ত্রুটিযুক্ত ডকুমেন্টেশনের প্রতিবেদন করবে। ইম্যাক্সের জন্য এলপিও নথিভুক্তি সম্পর্কে অভিযোগ করবে। Numpy নিয়মাবলী docstring reStructuredText সঙ্গে অনুসরণ করতে ভাল। পেপ 8, পেপ 257 এবং ডক্টেস্টের সাহায্যে পাই.েস্ট এবং টক্স স্বয়ংক্রিয়ভাবে চলার সাথে সেটআপ করা যেতে পারে।