«documentation» 태그된 질문

일부 언어의 문서가 "is"가 아니라 "equivalent"와 같은 이유는 무엇입니까? 예를 들어 파이썬 문서 는 itertools.chain(*iterables) ... 다음과 같습니다 . def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield element 또는 이 C ++ 참조 에 find_if: 이 함수 …

23 c++  python  documentation  compiler 

휴무 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 작년에 문을 닫았 습니다 . 몇 달 후에 코드를 다시 읽고 탐색해야 할 필요성이 최소화되도록 코드를 문서화하고 싶습니다. 소스 코드와 외부, 시퀀스 …

22 documentation  code-reviews  documentation-generation  help-documentation 

그것은 필드에 대한 getter 및 setter의 "자바 빈즈"구문을 포함하여 문서의 모든 것에 대한 논란 대상의 비트를 보인다 : 사람들이 말하는 그 불필요하게 길고 반복적 인 차단 DRY (중복 배제) , 명명 규칙을 설명해야 모든 것을 , 코드 / 문서가 복잡해집니다. 때로는 그러한 주장이 효과가 있습니다. 그러나 다른 경우에는 다음과 같이 …

22 documentation 

나는 '단위 테스트는 테스트 대상 코드를 문서화하는 매우 중요한 소스'라는 맥락에서 문장을 읽는 횟수를 셀 수 없습니다. 나는 그들이 진실임을 부정하지 않습니다. 그러나 개인적으로 나는 그것들을 문서로 사용하는 것을 찾지 못했습니다. 내가 사용하는 일반적인 프레임 워크의 경우 메소드 선언에 동작이 문서화되어 있으며 이것이 전부입니다. 그리고 단위 테스트는 해당 문서에 명시된 …

22 unit-testing  documentation 

현재 기능 및 기술 사양을 2 열 형식으로 작성하고 있습니다. 요약 문장 및 기술적 세부 사항. 세부 사항은 종종 다이어그램이있는 부록, 레이아웃 디자인을 나타냅니다. 그러나 나는 그것을 작성하는 시제로 고심하고 있습니다. 마치 일이 끝난 것처럼 과거 시제로 나는 일을 끝내는 일의 하이라이트 확장을 보여주기 위해 고군분투한다 X 가해 야 할 …

21 documentation  specifications  writing 

배경 : 저의 공동 연구자와 저는 학술지에 기사를 쓰고 있습니다. 연구 과정에서 Java로 시뮬레이션 프로그램을 작성했습니다. 우리는 다른 사람들이 사용할 수있는 시뮬레이션 프로그램을 자유롭게 만들고자합니다. 우리는 GitHub 리포지토리에서 코드를 호스팅하기로 결정했습니다. 다른 사람들이 쉽게 사용할 수 있도록 다음과 같은 프로그램에 대한 훌륭한 문서를 작성하려고합니다. 각 클래스 및 메소드에 대한 Javadoc …

20 java  documentation 

그래서 우리는 이와 같은 인터페이스를 가지고 있습니다 /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } 최근에 우리는 위와 같이 많은 XML …

20 c#  documentation  xml  documentation-generation 

휴무 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 육년 전 . 1 년 동안 WordPress 및 BuddyPress를 사용하여 소셜 네트워크 프로젝트에 참여한 후 프로그래머는 일주일에 한 번 급여를 받더라도 …

19 documentation  hiring  outsourcing  knowledge-transfer  wordpress 

가끔은 아니지만 종종 코드에 수학 논리를 포함시켜야합니다. 사용되는 개념은 대부분 매우 간단하지만 결과 코드는 목적이 불분명 한 많은 변수가 아니며 의도하지 않은 일부 작업은 아닙니다. 코드를 읽을 수 없거나 유지할 수 없다는 것을 의미하는 것은 아니며 실제 수학 문제보다 이해하기가 어렵다는 것을 의미합니다. 이해하기 어려운 부분에 대해서는 언급하려고 노력하지만, 코드를 …

19 java  documentation  math 

최근에 나는 현재 다루고있는 코드베이스의 일부를 리팩토링하는 일을 해왔다. 나 자신을 더 잘 이해하고있을뿐 아니라 코드를 다루는 다른 사람들이 더 쉽게 이해할 수 있도록하기 위해서다. 나는 그 생각의 측면에 의지하는 경향이 자기 문서화 코드가 좋은 것입니다 . 나는 그것이 더 깨끗하다고 ​​생각하고 코드가 스스로를 말하면 글쎄 ... 훌륭 합니다. 반면에 …

18 java  documentation  refactoring  javadocs 

휴무 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 오년 전에 . 잘 문서화 된 소프트웨어 개발은 ​​성공으로 이어진다는 것을 모두 알고 있습니다. 그러나 일반적으로 UML 다이어그램과 같이 일반 텍스트뿐만 …

18 documentation  wiki 

당신이 일을 떠나는 유일한 개발자라고 가정하십시오. 코드 외부에서 어떤 종류의 정보 / 자료를 작성하여 교체해야합니까? 분명한 대답은 "새 직장에서 무엇을 원 하든지"라는 것입니다. 그러나 새 직장을 시작한 지 얼마되지 않아서 제가 가장 중요한 것이 무엇인지 잊었습니다. 나는 생각 중입니다: 계정 / 암호 장비, 백업, 소프트웨어 CD의 위치 또 뭐요?

18 documentation  knowledge-transfer 

소프트웨어 프로젝트를보다 공식적으로 문서화하는 방법을 살펴 보았 으며 IEEE 830-1998 : 소프트웨어 요구 사항 사양 권장 사례에 대해 배웠습니다 . 그러나 해당 링크에서 볼 수 있듯이 대체되었습니다. 나는 830-1998, 그리고 아마도 830-1993은 아마도 사용하기에 적당하다는 것을 알고 있습니다. 그러나 다른 것이 없다면, 어떤 표준이 그것을 대체했는지 알고 싶습니다. 이 경우 …

17 documentation  requirements  standards 

우리는 모두 다음과 같이 "최소 시스템 요구 사항"과 함께 제공되는 수많은 소프트웨어 예제를 보았습니다. Windows XP / Vista / 7 1GB RAM 200MB 저장 용량 이것들은 일반적으로 어떻게 결정됩니까? 분명히 때로는 특정 제약 조건이 있습니다 (프로그램이 디스크에서 200MB를 사용하는 경우 어려운 요구 사항입니다). 이러한 상황 외에도 RAM이나 프로세서와 같은 경우에는 …

17 documentation  requirements  qa 

우리 팀의 개발자 중 하나는 메소드의 서명에 모든 매개 변수에 대한 javadoc 주석을 작성해야한다고 생각합니다. 나는 이것이 필요하다고 생각하지 않으며 실제로는 그것이 해로울 수도 있다고 생각합니다. 먼저 매개 변수 이름은 설명적이고 자체 문서화되어야한다고 생각합니다. 매개 변수가 무엇인지 즉시 분명하지 않으면 아마도 잘못하고있을 것입니다. 그러나 매개 변수가 무엇인지 명확하지 않은 경우가 …

17 java  documentation  source-code  comments  maintainability