필자가 작성한 작은 ActionScript 3 라이브러리에 대한 자체 문서를 작성하고 있습니다. 가능한 한 Adobe Livedocs의 레이아웃과 내용을 가깝게 유지하면서 조금만 정리하고 있습니다. 사람들이 내 설명서를 읽을 때 알아 두어야 할 모든 것을 다뤘지만, 내가 만든 클래스를 모두 추가하기 전에 중요한 것을 놓치고 싶지는 않다고 생각합니다. 설명서
우선, PHP 소스에서 문서를 생성하는 방법에 대해 묻지 않습니다. Doxygen이나 PHPDocumentor 같은 라이브러리를 사용하면 충분합니다. 내가 찾고있는 클래스, 메소드, 속성 등 인라인 phpdoc 기반 주석 스텁을 자동으로 생성하는 방법입니다 거기에 이미 할 수있는 기존 라이브러리가 있습니까? 나는 약간의 검색을했고 아무 것도 생각 나지 않았
우리는 개발 팀이므로 코드를 문서화해야합니다. 각 개발자는 모듈로 호출 할 수있는 코드의 일부로 작업합니다. 우리는이 사양을 가진 문서를 필요 구현하고 각 개발자 문서를 쉽게 사용할 수 있어야 그녀/자신의 작품과 다른 개발자가 모든 모듈에 대해 알 필요가있을 때, 그/그녀는 'shouldn 원본 개발자에게 문서에 관해 묻는 것이 좋습니다. 그는 자신이 직접
외부 고객에게 여러 어셈블리를 제공하지만 모든 공용 API가 공식적으로 지원되는 것은 아닙니다. 예를 들어, 최적의 디자인 선택이 적합하지 않기 때문에 나머지 코드가 작동하기 위해 유형이 어셈블리에서 공개적으로 노출되어야하지만 고객이 해당 유형을 사용하는 것을 원하지는 않습니다. 지원 부족을 전달하는 한 부분은 XML 주석의 형태로 인텔리 센스를 제공하지
다소 간단한 클래스의이 문서를 작성했지만 충분히 명확하지 않다고 생각합니다. 아무것도 바꾸어야합니까? /**
Pointer class that wraps resources loaded through the ResourceManager.
The manager is notified to increase or decrease the refere
방금 작성한 새로운 코드를 통해 클래스와 메소드에 NDoc sytle 주석을 추가합니다. 나는 꽤 좋은 MSDN 스타일의 문서를 생성하기를 기대하고있다. 일반적으로 클래스 및 메서드에 대한 의견을 쓸 때 좋은 지침은 무엇입니까? NDoc 의견은 무엇을 말해야합니까? 그들은 무엇을 말하지 않아야합니까? .NET 프레임 워크 주석이 말하는 것을 보았지만 느
우리는 ReSharper 6.0과 ReSharper를 함께 사용하고 있습니다. 우리는 문서 머리글이 있어야하는 StyleCop 규칙을 사용하지만 ReSharper의 코드 정리 기능은 필연적으로 쓰레기이기 때문에 문서 헤더를 생성하지 않습니다. 잘못된 문서 머리글은 처음에 추가 된 것보다 업데이트 가능성이 적기 때문에 아무 것도없는 것보다 더 나쁩니다. Re
이 주석을 jsdoc을 사용하여 올바르게 만들 수있는 방법은 무엇입니까? 어떤 아이디어 ??? /**********************
* @variables : global variables
***************************/
var map; // this var handle the object related with the map